rudy 0.3.2 → 0.4.0

data/CHANGES.txt

@@ -1,9 +1,60 @@
 RUDY, CHANGES
 
+TODO: Look into RubyGems error
+    /Library/Ruby/Gems/1.8/gems/rake-0.8.3/lib/rake/gempackagetask.rb:13:Warning: Gem::manage_gems is deprecated and will be removed on or after March 2009.
+    rake aborted!
+    RubyGem version error: rdoc(2.4.0 not ~> 2.3.0)
+
+TODO: Remove aws_swb
+
+
+#### 0.4.1 (2009-03-??) ###############################
+
+* CHANGE: Recommend keypair config to be in ~/.rudy/config
+* FIX: Rudy now checks for user keys specified by env-role, env, and global
+* FIX: gemspec dependency net-ssh-multi
+* NEW: rerelease command
+
+#### 0.4 (2009-03-12) ###############################
+
+NOTE: This is a significant re-write from 0.3
+
+* CHANGE: Mostly re-written bin/ruby, moving validation to Command classes 
+* CHANGE: upgrade to Drydock 0.5
+* CHANGE: Moved generic EC2 commands to bin/rudy-ec2
+* CHANGE: Removed ambiguity of pluralized command names.
+  * OLD: backups, disks, configs
+  * NEW: backup, disk, config
+* NEW: ssh and scp commands for connecting to and copying files to/from machines
+* NEW: New dependencies (trying out net-ssh)
+* NEW: Domain specific language for configuration
+* NEW: "Routines" for handling common actions. Starting, stopping, releasing, deploying. 
+* NEW: "rudy release" will create a release from the current working copy, start an instance, 
+checkout the release, run routines. It needs some work still, but this already functions as
+a single command release process. 
+* NEW: "rudy start|destroy|restart|update|status". Routines allow us to have generic commands 
+that can be used for any machine group. These commands relate to starting new instances.
+* NEW: Extra caution when running destructive commands
+* NEW: Default ~/.rudy/config created if it doesn't exist. 
+
+
+#### 0.3 (2009-02-26) ###############################
+
+NOTE: This is a significant re-write from 0.2
+
+* CHANGE: Re-written support/rudy-ec2-startup
+* CHANGE: upgrade to Drydock 0.4
+* NEW: More functionality for disks and backups
+* NEW: config commands
+* NEW: Per machine configuration (via ~/.rudy)
+
+
 #### 0.2 (2009-02-23) ###############################
 
 NOTE: This is a complete re-write from 0.1
 
+* CHANGE: Added Environment variables
+* CHANGE: upgrade to drydock 0.3.3
 * NEW: All time references are converted to UTC
 * NEW: Safer "Are you sure?". Number of characters to enter is 
        commiserate with amount of danger.  
@@ -16,10 +67,9 @@ NOTE: This is a complete re-write from 0.1
 * NEW: Partial support for regions and zones
 * NEW: Manage system based on security groups. 
 * NEW: "rudy groups" overhaul. Display, creates, destroys groups. 
-* CHANGE: Added Environment variables
-* UPGRADE: drydock 0.3.3
+
 
 
 #### 0.1 (2009-02-06) ###############################
 
-* Initial release
+* Initial public release

data/README.rdoc

@@ -1,12 +1,13 @@
-= Rudy - v0.3 BETA!
+= Rudy - v0.4 ALPHA!
 
 Rudy is a handy staging and deployment tool for EC2.
 
-NOTE: Rudy is not ready for general consumption. Come back in Q2 2009!
+NOTE: Rudy will be ready for general consumption in Q2 2009.
 
 == Installation
 
-# Soon!
+* Soon!
+* ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION' (See net/ssh docs)
 
 == More Info
 
@@ -23,8 +24,11 @@ NOTE: Rudy is not ready for general consumption. Come back in Q2 2009!
 
 == Thanks
 
-* The Rilli[http://rilli.com/] team, for the initial use case and support. 
-* Alicia Eyre Vasconcelos, for the name ("H-e-l-l-o R.U.D.Y")
+* The Rilli.com team -- for the initial use case, the ongoing feedback and support, and the good times!
+  * Adam Bognar
+  * Andrew Simpson
+  * Caleb Buxton
+  * Colin Brumelle
 
 
 == License

data/bin/rudy

@@ -4,348 +4,171 @@
 #
 #   See rudy -h for usage
 # 
-# AWS commands need the access identifiers. If you don't want
-# to include them as arguments, you can set the following variables
-# in your environment (replace **** with the literal value):
-#
-
-#
-# No Ruby 1.9.1 support. Only 1.8.x for now :[
-unless RUBY_VERSION < "1.9"
-  puts "Sorry! We're using the right_aws gem and it doesn't support Ruby 1.9 yet."
-  exit 1
-end
 
-RUDY_HOME = File.join(File.dirname(__FILE__))
-RUDY_LIB = File.join(RUDY_HOME, '..', 'lib')
+RUDY_HOME = File.join(File.dirname(__FILE__), '..')
+RUDY_LIB = File.join(RUDY_HOME, 'lib')
 $:.unshift RUDY_LIB # Put our local lib in first place
 
-require 'rubygems'
-require 'openssl'
-
+require 'rubygems' if RUBY_VERSION < "1.9"
+require 'date'
 require 'drydock'
-require 'rudy'
 extend Drydock
 
-
-
-default :commands
-
-
-global_usage "rudy [global options] COMMAND [command options]"
-global_option :A, :access_key, "AWS Access Key", String
-global_option :S, :secret_key, "AWS Secret Access Key", String
-global_option :R, :region, String, "Connect to a specific EC2 region (default: #{Rudy::DEFAULT_REGION})"
-
-#global_option :z, :zone, String, "Connect to a specific EC2 zone (default: #{Rudy::DEFAULT_ZONE})"
-global_option :e, :environment, String, "Connect to the specified environment (default: #{Rudy::DEFAULT_ENVIRONMENT})"
-global_option :r, :role, String, "Connect to a machine with the specified role (defalt: #{Rudy::DEFAULT_ROLE})"
-global_option :p, :position, String, "Position in the machine in its group (default: #{Rudy::DEFAULT_POSITION})"
-
-global_option :u, :user, String, "Provide a username (default: #{Rudy::DEFAULT_USER})"
-
-#global_option :c, :config, String, "Specify the config file to read (default: #{Rudy::RUDY_CONFIG})"
-
-
-global_option :V, :version, "Display version number" do
-  puts "Rudy version: #{Rudy::VERSION}"
-  exit 0
-end
-global_option :v, :verbose, "Increase verbosity of output (i.e. -v or -vv or -vvv)" do
+project "Rudy"  # This also runs require 'ruby'
+
+global :A, :accesskey, String, "AWS Access Key"
+global :S, :secretkey, String, "AWS Secret Access Key"
+#global :R, :region, String, "Connect to a specific EC2 region (ie: #{Rudy::DEFAULT_REGION})"
+global :f, :config, String, "Specify another configuration file to read (ie: #{Rudy::RUDY_CONFIG_FILE})"
+global :z, :zone, String, "Connect to a specific EC2 zone (ie: #{Rudy::DEFAULT_ZONE})"
+global :e, :environment, String, "Connect to the specified environment (ie: #{Rudy::DEFAULT_ENVIRONMENT})"
+global :r, :role, String, "Connect to a machine with the specified role (ie: #{Rudy::DEFAULT_ROLE})"
+global :p, :position, String, "Position in the machine in its group (ie: #{Rudy::DEFAULT_POSITION})"
+global :u, :user, String, "Provide a username (ie: #{Rudy::DEFAULT_USER})"
+global :q, :quiet, "Run with less output"
+global :v, :verbose, "Increase verbosity of output (i.e. -v or -vv or -vvv)" do
   @verbose ||= 0
   @verbose += 1
 end
-global_option :q, :quiet, "Run with less output"
-
-command :commands => Rudy::Command::Metadata do |obj|
-  obj.print_header
-  
-  puts "Rudy can do all of these things:", ""
-  command_names.sort.each do |cmd|
-    puts " %16s" % cmd
-  end
-  puts 
-  puts "Try: rudy -h OR rudy COMMAND -h"
-  puts
+global :V, :version, "Display version number" do
+  puts "Rudy version: #{Rudy::VERSION}"
+  exit 0
 end
 
-debug :off
+#desc "Run this the first time you use Rudy (it's immutable so running it again does no harm)."
+#command :setup => Rudy::Command::Metadata
 
-usage "rudy init"
-command :init => Rudy::Command::Metadata do |obj|
-  obj.setup
-end
 
-usage "rudy info"
-command :info => Rudy::Command::Metadata do |obj|
-  obj.info
-end
+# ------------------------------------  RUDY INFO COMMANDS  --------
+# ------------------------------------------------------------------
 
-option :a, :all, "Display config settings for all machines"
-option :d, :defaults, "Display the default value for the supplied parameter"
-usage "rudy [-f config-file] config [param-name]"
-command :config => Rudy::Command::Environment do |obj, argv|
-  obj.config(argv.first)
-end
+#usage "rudy info"
+#desc "Displays info about the current Rudy configuration"
+#command :info => Rudy::Command::Metadata
 
+usage "rudy [-f config-file] config [param-name]"
+desc "Check Rudy configuration."
+option :l, :all, "Display config settings for all machines"
+option :d, :defaults, "Display the default value for the supplied parameter"
+argv :name
+command :config => Rudy::Command::Config
 
+usage "rudy myaddress [-i] [-e]"
+desc "Displays you current internal and external IP addresses"
 option :e, :external, "Display only external IP address"
 option :i, :internal, "Display only internal IP address"
-usage "rudy myaddress [-i] [-e]"
 command :myaddress do |obj|
-  ea = Rudy::Utils::external_ip_address  
-  ia = Rudy::Utils::internal_ip_address
-  puts "%10s: %s" % ['Internal', ia] unless obj.external && !obj.internal
-  puts "%10s: %s" % ['External', ea] unless obj.internal && !obj.external
-end
-
-
-option :D, :destroy, "Destroy all metadata stored in SimpleDB"
-option :u, :update, "Update the role or environment metadata for the given instance-IDs"
-usage "rudy [global options] metadata instance-ID"
-command :metadata => Rudy::Command::Metadata do |obj, argv|
-  obj.print_header
-  
-  if obj.update
-    raise "No instance ID!" if argv.empty?
-    raise "Nothing to change (see global options -r or -e)" unless obj.role || obj.environment
-    obj.update_metadata(argv.first)
-  elsif obj.destroy
-    exit unless are_you_sure?
-    obj.destroy_metadata
-  else
-    obj.print_metadata(argv.first)
-  end
-end
-
-
-option :i, :instance, String, "Instance ID to associate the id"
-option :A, :associate, "Associate an address to a running instance"
-usage "rudy [global options] addresses [-A -i instance ID] [address]"
-command :addresses => Rudy::Command::Addresses do |obj, argv|
-  obj.print_header
-  
-  if obj.associate
-    obj.associate_address(argv.first)
+  ea = Rudy::Utils::external_ip_address || '' 
+  ia = Rudy::Utils::internal_ip_address || ''
+  if obj.global.quiet
+    puts ia unless obj.option.external && !obj.option.internal
+    puts ea unless obj.option.internal && !obj.option.external
   else
-    obj.print_addresses
-  end
-end
-
-
-
-option :p, :print, "Only print the SSH command, don't connect"
-usage "rudy [-e env] [-u user] connect [-p]"
-command :connect => Rudy::Command::Environment do |obj|
-  capture(:stderr) do
-    obj.print_header
-    obj.connect
+    puts "%10s: %s" % ['Internal', ia] unless obj.option.external && !obj.option.internal
+    puts "%10s: %s" % ['External', ea] unless obj.option.internal && !obj.option.external
   end
 end
 
 
-option :r, :remote, "Copy FROM the remote machine to the local machine"
-option :p, :print, "Only print the SSH command, don't connect"
-usage "rudy [-e env] [-u user] copy [-p] -r [from path] [to path]"
-command :copy => Rudy::Command::Environment do |obj, argv|
-  capture(:stderr) do
-    obj.print_header
-    raise "No path specified (rudy copy FROM-PATH [FROM-PATH ...] TO-PATH)" unless argv.size >= 2
-    obj.copy(argv)
-  end
-end
 
+# -----------------------------  RUDY MAINTENANCE COMMANDS  --------
+# ------------------------------------------------------------------
 
-option :all, "Display all disk definitions"
+usage "#{$/} [global options] disks [-C -p path -d device -s size] [-A] [-D] [disk name]"
+desc "Manage Disks"
+option :l, :all, "Display all disk definitions"
 option :p, :path, String, "The filesystem path to use as the mount point"
 option :d, :device, String, "The device id (default: /dev/sdh)"
 option :s, :size, Integer, "The size of disk (in GB)"
-option :C, :create, "Create a disk definition"
-option :D, :destroy, "Destroy a disk definition"
-option :A, :attach, "Attach a disk"
-option :N, :unattach, "Unattach a disk"
-usage "rudy [global options] disks [-C -p path -d device -s size] [-A] [-D] [disk name]"
-command :disks => Rudy::Command::Disks do |obj, argv|
-  capture(:stderr) do
-  obj.print_header
-  if obj.create
-    raise "No filesystem path specified" unless obj.path
-    raise "No size specified" unless obj.size
-    obj.create_disk
-  elsif obj.destroy
-    raise "No disk specified" if argv.empty?
-    exit unless are_you_sure?(5)
-    obj.destroy_disk(argv.first)
-  elsif obj.unattach
-    raise "No disk specified" if argv.empty?
-    exit unless are_you_sure?(4)
-    obj.unattach_disk(argv.first)
-  elsif obj.attach
-    raise "No disk specified" if argv.empty?
-    obj.attach_disk(argv.first)
-  else
-    obj.print_disks
-  end
-  obj.print_footer
-  end
-end
+action :C, :create, "Create a disk definition"
+action :D, :destroy, "Destroy a disk definition"
+action :A, :attach, "Attach a disk"
+action :N, :unattach, "Unattach a disk"
+argv :diskname
+command :disk => Rudy::Command::Disks
 
-option :s, :snapshot, String, "Create a backup entry from an existing snapshot"
-option :Z, :synchronize, "Check for and delete backup metadata with no snapshot. DOES NOT delete snapshots."
-#option :T, :tidy, "Tidy existing backups"
-option :D, :destroy, "Destroy a backup"
-option :C, :create, "Create a backup"
-usage "rudy [global options] backups [-C] [disk name]"
-command :backups => Rudy::Command::Disks do |obj, argv|
-  capture(:stderr) do
-    obj.print_header
-    if obj.create
-      obj.create_backup(argv.first)
-    elsif obj.synchronize
-      unless argv.empty?
-        puts "The disk you specified will be ignored."
-        argv.clear
-      end
-      obj.sync_backups
-    elsif obj.destroy
-      raise "No backup specified" if argv.empty?
-      #exit unless are_you_sure?
-      obj.destroy_backup(argv.first)
-    else
-      obj.print_backups
-    end
-  end
-end
 
+usage "rudy [global options] backups [-C] [disk name]"
+desc "Manage Backups"
+option :s, :snapshot, String, "Create a backup entry from an existing snapshot"
+action :Z, :sync, "Check for and delete backup metadata with no snapshot. DOES NOT delete snapshots."
+#action :T, :tidy, "Tidy existing backups"
+action :D, :destroy, "Destroy a backup and DELETE its snapshots."
+action :C, :create, "Create a backup"
+argv :disk
+command :'backup' => Rudy::Command::Backups
+command_alias :backup, :bu
 
-option :D, :destroy, "Destroy a volume"
-command :volumes => Rudy::Command::Volumes do |obj, argv|
-  capture(:stderr) do
-    obj.print_header
-    
-    if obj.destroy
-      exit unless are_you_sure? 4
-      obj.destroy_volume(argv.first)
-    else
-      obj.print_volumes
-    end
-  end
-end
 
-option :all, "Display all instances"
-option :a, :address, String, "Amazon elastic IP"
-option :i, :image, String, "Amazon machine image ID (ami)"
-option :v, :volume, String, "Amazon volume ID"
-option :D, :destroy, "Destroy the given instance IDs. All data will be lost!"
-option :S, :start, "Start an instance"
-usage "rudy [global options] instances [-D] [-S -i image ID] [instance ID OR group name]"
-command :instances => Rudy::Command::Instances do |obj, argv|
-  capture(:stderr) do
-  obj.print_header
-  if obj.destroy
-    exit unless are_you_sure?
-    obj.destroy_instances(argv.first)
-  elsif obj.start
-    exit unless are_you_sure?
-    obj.start_instance
-  else
-    obj.print_instances(argv.first)
-  end
-  obj.print_footer
-  end
-end
+usage "rudy [global options] metadata instance-ID"
+desc "Display Rudy metadata."
+command :metadata => Rudy::Command::Metadata
+command_alias :metadata, :md
 
 
-option :a, :account, String, "Your Amazon Account Number"
-option :i, :image_name, String, "The name of the image"
-option :b, :bucket_name, String, "The name of the bucket that will store the image"
-option :C, :create, "Create an image"
-option :D, :destroy, "Deregister an image (currently _does not_ remove images files from S3)"
-usage "rudy images [-C -i name -b bucket -a account] [-D AMI-ID]"
-command :images => Rudy::Command::Images do |obj, argv|
-  capture(:stderr) do
-  obj.print_header
-  
-  if obj.create
-    puts "Make sure the machine is clean. I don't want archive no crud!"
-    exit unless are_you_sure?
-    obj.create_image
-    
-  elsif obj.destroy
-    obj.deregister(argv.first)
-    
-  else
-    obj.print_images
-  end
-  
-end
-end
+desc "Machine Group Status"
+command :status => Rudy::Command::Machines
 
 
+#desc "Update a Machine Group with the current version of Rudy"
+#command :update => Rudy::Command::Machines
 
-command :stage => Rudy::Command::Stage do |obj| 
-  capture(:stderr) do
-  obj.print_header
-  
-  raise "No SCM defined. Set RUDY_SVN_BASE or RUDY_GIT_BASE." unless obj.scm
-  
-  exit unless are_you_sure?
-  obj.push_to_stage
-  end
-end
 
+usage "rudy [-e env] [-u user] connect [-p] [cmd]"
+desc "Open an SSH connection"
+option :p, :print, "Only print the SSH command, don't connect"
+argv :cmd
+command :connect => Rudy::Command::Environment 
+command_alias :connect, :ssh
 
+usage "rudy [-e env] [-u user] copy [-p] -r [from path] [to path]"
+desc "Copy files to or from machines. NOTE: You must use quotes when using a tilda for your remote dir ('~/')."
+option :r, :remote, "Copy FROM the remote machine to the local machine"
+option :p, :print, "Only print the SSH command, don't connect"
+argv :from, :to
+command :copy => Rudy::Command::Environment
+command_alias :copy, :scp
+command_alias :copy, :upload
+command_alias :copy, :download
 
 
-option :all, "Display all security groups"
-option :r, :protocols, Array, "Comma-separated list of protocols. One of: tcp (default), udp, icmp"
-option :p, :ports, Array, "List of comma-separated ports to authorize (default: 22,80,443)"
-option :a, :addresses, Array, "List of comma-separated IP addresses to authorize (default: your external IP)"
-option :C, :create, "Create a security group"
-option :D, :destroy, "Destroy a security group"
-option :M, :modify, "Modify a security group"
-usage "rudy [global options] groups [-C] [-a IP addresses] [-p ports] [group name]"
-command :groups => Rudy::Command::Groups do |obj, argv|
-  capture(:stderr) do
-  obj.print_header
-  
-  if obj.create
-    obj.create_group(argv.first)
-  
-  elsif obj.modify
-    obj.modify_group(argv.first)
-    
-  elsif obj.destroy
-    exit unless are_you_sure?
-    obj.destroy_group(argv.first)
-  
-  else
-    obj.print_groups(argv.first)
-  end
-  end
-end
+# --------------------------------  RUDY ROUTINES COMMANDS  --------
+# ------------------------------------------------------------------
 
+desc "Shutdown a Machine Group"
+command :shutdown => Rudy::Command::Machines
 
-__END__
+desc "Start a Machine Group"
+command :startup => Rudy::Command::Machines
+command_alias :startup, :start
 
-# Create the SimpleDB domain for storing metadata. Check environment variables. 
-rudy init
-rudy create-group -a address -i ami-1111111 -v vol-2222222
+desc "Restart a Machine Group"
+command :restart => Rudy::Command::Machines
 
-# Connect to stage-app-01 as root
-rudy --user root connect
+desc "Release to a machine group"
+option :s, :switch, "Switch to the release branch/tag"
+option :m, :msg, String, "A short release note"
+command :release => Rudy::Command::Release
 
-# Zone, environment, role and position are implied. 
-rudy disks -C -p /rilli/app -d /dev/sdh -s 100
-rudy disks -D disk-us-east-1b-stage-app-01-rilli-db222
+desc "Update the release currently running in a machine group"
+command :rerelease => Rudy::Command::Release
+command_alias :rerelease, :rere
 
-# Create an image from an existing instance
-rudy -e prod images -C -b rilli-ami-us -i rilli-app-32-r3
+#desc "Deploy disk snapshots from one machine to another"
+#command :deploy => Rudy::Command::Deploy
 
-# Create an instance 
-rudy -e prod instances -S -i ami-11111
 
 
-rudy release
 
+# -------------------------------------------  UGLY STUFFS  --------
+# ------------------------------------------------------------------
+debug :on
+capture :stderr       
+before do
+  @start = Time.now
+end
+after do
+  @elapsed = Time.now - @start
+  puts $/, "Elapsed: %.2f seconds" % @elapsed.to_f if @elapsed > 0.1
+end