capazon 0.1.0

data/CHANGELOG.txt

@@ -0,0 +1,4 @@
+== 2007/03/27
+
+* Initial Release
+* Provides Capistrano tasks wrapping the Amazon EC2 API

data/Manifest.txt

@@ -0,0 +1,14 @@
+Rakefile
+README.txt
+CHANGELOG.txt
+Manifest.txt
+setup.rb
+examples/deploy.rb
+lib/capazon/capistrano_plugin.rb
+lib/capazon/configuration.rb
+lib/capazon/meta_tasks.rb
+lib/capazon/tasks.rb
+lib/capazon/version.rb
+lib/capazon.rb
+test/test_helper.rb
+test/capazon_test.rb

data/README.txt

@@ -0,0 +1,55 @@
+= Capazon
+
+Capistrano tasks to manage Amazon EC2 Images.
+
+== Installation
+
+* <tt>gem install capazon</tt>
+* Edit your your <tt>config/deploy.rb</tt>:
+
+    require 'capazon'
+
+    #AWS login info
+    set :aws_access_key_id, 'XXX'
+    set :aws_secret_access_key, 'X'
+  
+    # Name of the keypair used to spawn and connect to the Amazon EC2 Instance
+    # Defaults to one created by the setup_keypair task 
+    set :aws_keypair_name, "#{application}-capazon"
+
+    # Path to the private key for the Amazon EC2 Instance mentioned above
+    # Detaults to one created by setup_keypair task
+    set :aws_private_key_path, "#{Dir.pwd}/#{aws_keypair_name}-key"
+
+    #defaults to an ubuntu image
+    #set :aws_ami_id, "ami-e4b6538d"
+    
+    #defaults to, um, default
+    #set :aws_security_group, "default"
+    
+== Tasks
+
+===== Notes:
+
+* <em>All tasks <b>require</b> aws_access_key_id and aws_secret_access_key.</em>
+* <em>All tasks optionally take environment variables in lieu of capistrano configuration variables.</em>
+
+[+create_keypair+]                Create a keypair aws_keypair_name and write out the generate private key to aws_private_key_path.
+[+delete_keypair+]                Deletes keypair aws_keypair_name.                                                                
+[+describe_keypairs+]             Describes keypairs.
+[+describe_images+]               Describes AMIs you have privilege to execute.
+[+run_instance+]                  Runs an instance of aws_ami_id with access available via aws_keypair_name.
+[+terminate_instance+]            Terminates aws_instance_id.
+[+describe_instances+]            Describes running AMIs.                 
+[+authorize_web_and_ssh_access+]  Opens tcp access on port 80 and 22 to the aws_security_group.
+
+==== Experimental Tasks
+
+[+run_and_configure_instance+]    Runs an instance of aws_ami_id with access available via aws_keypair_name, and - very experimentally - changes the root password, adds a user, gives that user sudo rights, then writes out a new deploy.rb to allow this new instance to be used with the 'deprec' gem.
+
+== Meta
+
+Rubyforge Project Page:: http://rubyforge.org/projects/capazon
+Author::    Jesse Newland (http://soylentfoo.jnewland.com) (jnewland@gmail.com[maito:jnewland@gmail.com])
+Copyright:: Copyright (c) 2007 Jesse Newland
+License::   Distributes under the same terms as Ruby

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'fileutils'
+require 'hoe'
+include FileUtils
+require File.join(File.dirname(__FILE__), 'lib', 'capazon', 'version')
+
+AUTHOR = "jnewland"
+EMAIL = "jnewland@gmail.com"
+DESCRIPTION = "A Capistrano extension library to manage Amazon EC2 instances"
+GEM_NAME = "capazon"
+RUBYFORGE_PROJECT = "capazon"
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+
+
+NAME = "capazon"
+VERS = ENV['VERSION'] || (Capazon::VERSION::STRING)
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = ['--quiet', '--title', "capazon documentation",
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject { |x| Array(x).first == 'hoe' } 
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.author = AUTHOR 
+  p.description = DESCRIPTION
+  p.email = EMAIL
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/*_test.rb"]
+  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of('CHANGELOG.txt', 0..1).join("\n\n")
+  #p.extra_deps << %w(amazon-ec2 capistrano deprec mongrel_cluster)
+  p.extra_deps << %w(amazon-ec2 capistrano)
+  #p.spec_extras    - A hash of extra values to set in the gemspec.
+end

data/examples/deploy.rb

@@ -0,0 +1,22 @@
+require 'capazon'
+
+set :application, "railsapp"
+set :repository, "http://svnhost.com/svn/#{application}"
+
+set :aws_access_key_id, 'XXX'
+set :aws_secret_access_key, 'X'
+set :user, "desired_user"
+set :username, user
+
+# Name of the keypair used to spawn and connect to the Amazon EC2 Instance
+# Defaults to one created by the setup_keypair task 
+set :aws_keypair_name, "#{application}-capazon"
+
+# Path to the private key for the Amazon EC2 Instance mentioned above
+# Detaults to one created by setup_keypair task
+set :aws_private_key_path, "#{Dir.pwd}/#{aws_keypair_name}-key"
+
+#defaults to an ubuntu image
+#set :aws_ami_id, "ami-e4b6538d"
+
+#set :aws_security_group, "default"

data/lib/capazon.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+##
+Dir[File.join(File.dirname(__FILE__), 'capazon/**/*.rb')].sort.each { |lib| require lib }

data/lib/capazon/capistrano_plugin.rb

@@ -0,0 +1,106 @@
+# Capistrano Plugin to provide access to the amazon-ec2 gem's methods
+#
+# Author::    Jesse Newland (jnewland@gmail.com)
+# Copyright:: Copyright (c) 2007 Jesse Newland
+# License::   Distributes under the same terms as Ruby
+
+gem 'amazon-ec2'
+require 'ec2'
+module CapistranoPlugin
+  
+  #returns an EC2::AWSAuthConnection object
+  def connect(auth)
+    amazon = EC2::AWSAuthConnection.new(auth[:AWS_ACCESS_KEY_ID], auth[:AWS_SECRET_ACCESS_KEY])
+    raise Exception, "Connection to AWS failed. Check your Access Key ID and Secret Access Key - http://aws.amazon.com/" if amazon.nil?
+    return amazon
+  end
+  
+  def setup_keypair(auth,keypair_name,private_key_path=nil)
+    amazon = connect(auth)
+              
+    #verify keypair doesn't already exist
+    raise Exception, "Keypair #{keypair_name} already exists." unless amazon.describe_keypairs(keypair_name).parse.empty?
+    
+    #create keypair
+    private_key = amazon.create_keypair(keypair_name)
+    raise Exception, "Private Key not correctly generated" unless private_key.parse[0][0] == "KEYPAIR"
+    puts "Keypair \"#{keypair_name}\" generated"
+    
+    unless private_key_path == nil
+      #write private key to file
+      text_private_key = private_key.parse.inject("") { |text_private_key, a| a.join("\t") + "\n" }
+      File.open(private_key_path, 'w') do |file|
+        file.write(text_private_key)
+      end
+      system "chmod 600 #{private_key_path}"
+      puts "Written to ./#{private_key_path}"
+    end
+  end
+  
+  def delete_keypair(auth,keypair_name)
+    amazon = connect(auth)
+        
+    raise Exception, "Keypair #{keypair_name} does not exist." if amazon.describe_keypairs(keypair_name).parse.empty?
+    keypair_response = amazon.delete_keypair(keypair_name).parse.to_s
+    raise Exception, "Failed Authorizing Web Access" unless keypair_response == "Keypair deleted."
+    puts "Keypair \"#{keypair_name}\" deleted"
+  end
+  
+  def authorize_access(auth,group_name,ip_protocol,from_port,to_port,cidr_ip="0.0.0.0/0")
+    amazon = connect(auth)
+    web_security_response = amazon.authorize_security_group_ingress("", :groupName => group_name, :ipProtocol => ip_protocol, :fromPort => from_port, :toPort => to_port, :cidrIp => cidr_ip).parse.to_s
+    raise "Failed Authorizing Web Access" unless web_security_response == "Ingress authorized."
+    puts "Access Granted for #{group_name} group on interface #{cidr_ip} for #{ip_protocol} port(s) #{from_port} to #{to_port}."
+  end
+  
+  def run_instance(auth,ami_id,keypair_name,group_ids=[],min_count=1,max_count=1,user_data=nil,base64_encoded=false)
+    amazon = connect(auth)
+    instance = amazon.run_instances(ami_id, :minCount=>min_count, :maxCount=>max_count, :keyname=>keypair_name, :groupIds=>group_ids, :userData=>user_data, :base64Encoded=>base64_encoded).parse[1]
+    raise Exception, "Instance did not start" unless instance[4] == "pending"
+    instance_id = instance[1]
+    puts "Instance #{instance_id} Startup Pending"
+    
+    #loop checking for instance startup
+    puts "Checking every 10 seconds to detect startup for up to 5 minutes"
+    tries = 0
+    begin
+      instance_desc = amazon.describe_instances.parse.select { |i| i[1] == instance_id.to_s }[0]
+      raise "Server Not Running" unless instance_desc[4] == "running"
+      sleep 5
+      return instance_desc
+    rescue
+      puts "."
+      sleep 10
+      tries += 1
+      retry unless tries == 35
+      raise "Server Not Running"
+    end
+  end
+  
+  def terminate_instance(auth,instance_id)
+    amazon = connect(auth)    
+    amazon.terminate_instances(instance_id).parse
+  end
+  
+  def describe_images(auth,imageIds=[], owners=[], executableBy=[])
+    amazon = connect(auth)
+    amazon.describe_images(imageIds,owners,executableBy).parse
+  end
+  
+  def describe_instances(auth,instanceIds=[])
+    amazon = connect(auth)
+    amazon.describe_instances(instanceIds).parse
+  end
+  
+  # def reboot_instances(*instance_ids)
+  #   puts "not yet implmented"
+  # end
+  
+  def describe_keypairs(auth,keyNames=[])
+    amazon = connect(auth)    
+    amazon.describe_keypairs(keyNames).parse
+  end
+  
+  
+end
+Capistrano.plugin :capazon, CapistranoPlugin

data/lib/capazon/configuration.rb

@@ -0,0 +1,10 @@
+# Author::    Jesse Newland (jnewland@gmail.com)
+# Copyright:: Copyright (c) 2007 Jesse Newland
+# License::   Distributes under the same terms as Ruby
+
+Capistrano.configuration(:must_exist).load do
+  require 'deprec/recipes'
+   
+  set :aws_ami_id, "ami-e4b6538d"
+  set :aws_security_group, "default"
+end

data/lib/capazon/meta_tasks.rb

@@ -0,0 +1,82 @@
+# Author::    Jesse Newland (jnewland@gmail.com)
+# Copyright:: Copyright (c) 2007 Jesse Newland
+# License::   Distributes under the same terms as Ruby
+
+Capistrano.configuration(:must_exist).load do
+  desc <<-DESC
+  Runs an instance of AWS_AMI_ID with AWS_KEYPAIR_NAME, and - very experimentally - changes the root password, adds a user, gives that user sudo rights, then writes out a new deploy.rb to allow this new instance to be used with the 'deprec' gem.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAMEE
+  DESC
+  task :run_and_configure_instance do
+    create_keypair
+  
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    ami_id = ENV['AWS_AMI_ID'] || aws_ami_id
+    keypair_name = ENV['AWS_KEYPAIR_NAME'] || aws_keypair_name
+    private_key_path = ENV['AWS_PRIVATE_KEY_PATH'] || aws_private_key_path
+    instance_desc = capazon.run_instance({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key},ami_id,keypair_name)
+  
+    authorize_web_and_ssh_access
+      
+    puts "Waiting one additional minute for startup..."
+    sleep 60
+  
+    #change password
+    puts "Connecting to #{instance_desc[3]}..."
+    puts "Please create a secure root password"
+    system "ssh -o StrictHostKeyChecking=no -i #{private_key_path} root@#{instance_desc[3]} passwd"
+    puts "Creating #{user} user"
+    system "ssh -o StrictHostKeyChecking=no -i #{private_key_path} root@#{instance_desc[3]} 'groupadd wheel;useradd -m -G wheel -s /bin/bash #{user};passwd #{user}'"
+    puts "Adding wheel group to sudoers"
+    system "ssh -o StrictHostKeyChecking=no -i #{private_key_path} root@#{instance_desc[3]} 'chmod 640 /etc/sudoers; echo -e \"#{user}\tALL=(ALL)\tALL\" >> /etc/sudoers;chmod 440 /etc/sudoers'"
+    # puts "Setting up loopback interface"
+    #     system "ssh -o StrictHostKeyChecking=no -i #{private_key_path} root@#{instance_desc[3]} 'echo -e \"127.0.0.1\tlocalhost\" > /etc/hosts;echo -e \"iface lo inet loopback\" >> /etc/network/interfaces;ifup lo'"
+    #     puts "Appending source list"
+    #     system "ssh -o StrictHostKeyChecking=no -i #{private_key_path} root@#{instance_desc[3]} 'echo -e \"deb http://archive.ubuntu.com/ubuntu edgy main restricted universe multiverse\ndeb http://archive.ubuntu.com/ubuntu/ edgy-updates main restricted universe multiverse\" >/etc/apt/sources.list'"
+  
+    #append capazon config info
+      
+    original = File.open("config/deploy.rb")
+    backup = File.open("config/deploy.rb.capazon", "w")
+    while original.gets do
+        backup.print $_
+    end
+    backup.close
+    original.close
+  
+    puts "Overwriting capistrano configuration..."
+    system "yes | deprec --apply-to . --name #{application} --domain #{instance_desc[3]}"
+  
+    puts "Updating deprec config with amazon information..."
+
+    deprec = File.open("config/deploy.rb")
+    capazon = File.open("config/deploy.rb.capazon")
+    deprec_capazon = File.open("config/deploy.rb.deprec_capazon", "w")
+  
+    while deprec.gets do
+        if $. == 1 then
+            deprec_capazon.print "#Capazon Configuration\n"
+            deprec_capazon.print "\nset :aws_instance_id, '#{instance_desc[1]}'\n\n"
+            while capazon.gets do
+                unless $. == 1 || $_ == nil
+                  deprec_capazon.print $_
+                end
+            end
+        end
+        unless $_ == nil || /^set :repository/.match($_) || /^set :application/.match($_) || /XXX/.match($_)
+          deprec_capazon.print $_
+        end 
+    end
+  
+    capazon.close
+    deprec.close
+    deprec_capazon.close
+    File.rename("config/deploy.rb", "config/deploy.rb.deprec")
+    File.rename("config/deploy.rb.deprec_capazon", "config/deploy.rb")
+  
+    puts "Done!"
+  end
+  
+end

data/lib/capazon/tasks.rb

@@ -0,0 +1,112 @@
+# Capistrano Plugin to provide access to the amazon-ec2 gem's methods
+# Author::    Jesse Newland (jnewland@gmail.com)
+# Copyright:: Copyright (c) 2007 Jesse Newland
+# License::   Distributes under the same terms as Ruby
+
+Capistrano.configuration(:must_exist).load do
+  
+  desc <<-DESC
+  Create a keypair AWS_KEYPAIR_NAME and
+  write out the generate private key to AWS_PRIVATE_KEY_PATH.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :create_keypair do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    keypair_name = ENV['AWS_KEYPAIR_NAME'] || aws_keypair_name
+    private_key_path = ENV['AWS_PRIVATE_KEY_PATH'] || aws_private_key_path
+    capazon.setup_keypair({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key}, keypair_name, private_key_path)
+  end
+  
+  desc <<-DESC
+  Deletes keypair AWS_KEYPAIR_NAME.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :delete_keypair do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    keypair_name = ENV['AWS_KEYPAIR_NAME'] || aws_keypair_name
+    capazon.delete_keypair({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key}, keypair_name)
+  end
+  
+  desc <<-DESC
+  Runs an instance of AWS_AMI_ID with AWS_KEYPAIR_NAME.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :run_instance do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    ami_id = ENV['AWS_AMI_ID'] || aws_ami_id
+    keypair_name = ENV['AWS_KEYPAIR_NAME'] || aws_keypair_name
+    instance_desc = capazon.run_instance({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key},ami_id,keypair_name)
+    puts instance_desc.join("\t")
+  end
+  
+  desc <<-DESC
+  Opens tcp access on port 80 and 22 to the specified security group.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :authorize_web_and_ssh_access do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    group_name = ENV['AWS_SECURITY_GROUP'] || (aws_security_group rescue "default")
+    capazon.authorize_access({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key},group_name,"tcp","80","80","0.0.0.0/0")
+    capazon.authorize_access({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key},group_name,"tcp","22","22","0.0.0.0/0")
+  end
+  
+  desc <<-DESC
+  Terminates AWS_INSTANCE_ID.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :terminate_instance do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    instance_id = ENV['AWS_INSTANCE_ID'] || aws_instance_id
+    respnse = capazon.terminate_instance({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key}, instance_id)
+    puts respnse.join("\t")
+  end
+  
+  desc <<-DESC
+  Describes keypairs.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :describe_keypairs do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    capazon.describe_keypairs({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key}).each do |keypair|
+      puts keypair.join("\t")
+    end
+  end
+  
+  desc <<-DESC
+  Describes running AMIs.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :describe_instances do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    capazon.describe_instances({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key}).each do |instance|
+      puts instance.join("\t")
+    end
+  end
+ 
+  desc <<-DESC
+  Describes AMIs you have privilege to execute.
+  Requires Amazon authorization credentials:
+  AWS_ACCESS_KEY_ID, AWS_KEYPAIR_NAME
+  DESC
+  task :describe_images do
+    access_key_id = ENV['AWS_ACCESS_KEY_ID'] || aws_access_key_id
+    secret_access_key = ENV['AWS_SECRET_ACCESS_KEY'] || aws_secret_access_key
+    capazon.describe_images({:AWS_ACCESS_KEY_ID => access_key_id, :AWS_SECRET_ACCESS_KEY => secret_access_key}).each do |image|
+      puts image.join("\t")
+    end
+  end  
+end