solutious-rudy 0.5.1 → 0.6.0

data/CHANGES.txt

@@ -1,5 +1,23 @@
 RUDY, CHANGES
 
+* TODO: Remove string messages for non-string output formats
+* TODO: Support for reserved instances
+* TODO: Test for zone and region support
+* TODO: Support for machine image attributes
+* TODO: Support for product codes
+* TODO: HTTPS
+
+
+#### 0.6.0 (2009-04-19) ###############################
+
+NOTE: This is a significant re-write from 0.5
+
+* CHANGE: Rebuilt Rudy::AWS::*
+* CHANGE: Removed lib/rudy/commands/* and lib/rudy/metadata/*
+* ADDED: rudy-ec2 executable
+* CHANGE: have local copies of Caesars and Drydock to reduce external dependencies. 
+* ADDED: new output formats: yaml, json, csv, tsv
+
 
 #### 0.5.1 (2009-04-10) ###############################
 
@@ -17,7 +35,7 @@ NOTE: This is a significant re-write from 0.4
 * ADDED: --nocolor option 
 * ADDED: Ruby API
 * ADDED: Tests with 55% coverage
-* ADDED: Ruby API (Rudy::Instances, etc...)
+* ADDED: Ruby API (Rudy::Machines, etc...)
 * ADDED: ird, a REPL (experimental)
 * ADDED: Now uses Rye 0.4.1
 

data/README.rdoc

@@ -1,44 +1,66 @@
-= Rudy - v0.5 ALPHA
+= Rudy - v0.6 ALPHA
 
-Rudy is a development and deployment tool for Amazon EC2. It's both a command-line tool and Ruby library. Here's an example from both for creating an EC2 security group:
+Rudy is a command-line development and deployment tool for Amazon Web Services. It helps you build and manage machines in EC2 by organizing them into groups of _environments_ and _roles_. These are called _machine groups_. <tt>stage</tt> is the default environment and <tt>app</tt> is the default role. You can run multiple machines with the same role. These are called _positions_. Rudy also supports running machine groups across availability _zones_. 
 
-     $ rudy group --create
+When you put all this together, you have a unique name for every machine. The default machine is:
 
-     OR
-     
-     rgroup = Rudy::Groups.new
-     rgroup.create
+             zone     env  role
+              v        v    v   
+        m-us-east-1b-stage-app-01
+        ^                       ^
+     "machine"                position
 
+All configuration is organized into the zones, environments, and roles that you specify (Rudy assumes positions are identical which is important for backups and scaling). And as you'd expect, the defaults can be changed too (in <tt>~/.rudy/config</tt>). See below for usage examples. 
+
+<b>NOTE: This is an ALPHA release. That means Rudy's not ready for production use! See Alpha Warning.</b>
 
 == Installation
 
-=== Step 1 (get Rudy on to your machine):
+=== Step 1 of 2 (get Rudy on to your machine):
 
 Via Rubygems, one of:
 
-  $ sudo gem install rudy
-  $ sudo gem install solutious-rudy --source http://gems.github.com/
+    $ sudo gem install rudy
+    $ sudo gem install solutious-rudy --source http://gems.github.com/
+
+or via download:
+* rudy-0.6.0.tar.gz[http://github.com/solutious/rudy/tarball/rudy-0.6.0]
+* rudy-0.6.0.zip[http://github.com/solutious/rudy/zipball/rudy-0.6.0]
+
+NOTE: <em>If you are not installing via RubyGems, you need to make sure the Ruby dependencies are in your LOAD_PATH (<tt>$:</tt>). Ryan Tomayko wrote a gist[http://gist.github.com/54177] about it.</em>
+
+=== Step 2 of 2 (initialize your configuration):
+
+    $ rudy generate-config
+      [edit ~/.rudy/config with your Amazon Web Services credentials] 
+    $ rudy init
+
+NOTE: <em>You need an Amazon[http://aws.amazon.com/] account to use Rudy. Sign up for EC2[http://aws.amazon.com/ec2/],  SimpleDB[http://aws.amazon.com/simpledb/], and S3[http://aws.amazon.com/s3/]</em>
+
+
+== Example -- Launch a Machine Group
+
+Machine groups are named after the current environment and role. The default machine group is <tt>stage-app</tt>. In this example, Rudy will create the default machine group from scratch. 
 
-Via GitHub:
-  $ git clone git://github.com/solutious/rudy.git
+<b>Note: Make sure your <tt>~/.rudy/config</tt> contains your AWS credentials</b>
 
-Via download:
-* rudy-0.5.1.tar.gz[http://github.com/solutious/rudy/tarball/rudy-0.5.1]
-* rudy-0.5.1.zip[http://github.com/solutious/rudy/zipball/rudy-0.5.1]
+We need to tell Rudy what this machine group should look like. We can generate a default machine configuration with this command:
 
-NOTE: If your are not installing via RubyGems, you will need to make sure the Ruby dependencies (see below) are installed and in your LOAD_PATH. 
+    $ rudy config --rudy > Rudyfile
 
-=== Step 2 (initialize your configuration):
+This will generate a config file called <tt>Rudyfile</tt> which contains a default machines and routines configuration. The machine configuration describes the "physical" characteristics of your machine groups. The routine configuration describes what happens when you startup and shutdown a machine group (Rudy refers to these as _routines_).
+    
+We can launch the default machine group (stage-app) with this command:
 
-     $ rudy generate-config
-     [modify ~/.rudy/config]
-     $ rudy init
+    $ rudy startup
 
-=== Step 3 (start working with EC2):
+You now have a new EC2 instance called <tt>m-us-east-1b-stage-app-01</tt> to work with. You can log into it with:
 
-     $ rudy group --create
-     $ rudy keypair --create
-     $ rudy instance --create
+    $ rudy -u root ssh
+    
+The <tt>-u root</tt> tells Rudy to open a connection as the root user. If you create an account on that instance, you can login as that user too. When you don't feel like paying for the instance you can run the following command to destroy it forever:
+
+    $ rudy shutdown
 
 
 == Dependencies:
@@ -47,45 +69,54 @@ NOTE: If your are not installing via RubyGems, you will need to make sure the Ru
 * Net::SSH[http://net-ssh.rubyforge.org/]
 * Net::SCP[http://net-ssh.rubyforge.org/]
 * amazon-ec2[http://github.com/grempe/amazon-ec2]
-* aws_sdb[http://rubyforge.org/projects/aws-sdb/]
-* Drydock[http://github.com/delano/drydock]
-* Caesars[http://github.com/delano/caesars]
 * Rye[http://github.com/delano/rye]
 
 
 == Common Errors
 
-* <tt>`require': no such file to load -- amazon-ec2 (LoadError)</tt>
+* <tt>"`require': no such file to load -- amazon-ec2 (LoadError)"</tt>
   * You're probably running a mix of Rubygem and non-Rubygem libraries. Ryan Tomayko has you covered: http://gist.github.com/54177
-
-* <tt>The request signature we calculated does not match the signature you provided.</tt>
+* <tt>"The request signature we calculated does not match the signature you provided."</tt>
   * Check that your Amazon Web Service access key and secret key are correct
+* <tt>"AWS was not able to validate the provided access credentials"</tt>
+  * If it's a new Amazon Account, you need to sign up for EC2, SDB, and S3. 
+
+== Alpha Warning
+
+Although Rudy has been pretty well tested and is currently being used in production in a private beta, it's not ready for general production use. There are a few things to keep in mind while Rudy is in alpha status.
 
-* <tt>AWS was not able to validate the provided access credentials</tt>
-  * If it's a new Amazon Accounts, you need to sign up for EC2, SDB, and S3. 
+* If you already have private SSH keys, back them up. Rudy is quite safe but hasn't been audited so backup your keys as a precaution.
+* If you're running EC2 instances in production, create a new set of AWS credentials (access key and secret key) to use with Rudy. This will ensure that Rudy has no access to your production instances. 
+* Rudy commands and APIs may change in later releases. This means that if you create an environment with an alpha release and later upgrade Rudy, some things may not work as expected. 
 
 
 == More Info
 
 * GitHub[http://github.com/solutious/rudy]
+* Issues[http://github.com/solutious/rudy/issues]
 * RubyForge[http://rubyforge.org/projects/rudy]
 * Inspiration[http://www.youtube.com/watch?v=CgaiIW5Rzes]
 
 
 == Thanks
 
-* The Rilli.com team -- for the initial use case, the ongoing feedback and support, and the good times!
+* The Rilli.com[http://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
+* Everyone at Utrecht.rb[http://groups.google.com/group/utrecht-rb]
+* Jamis Buck for writing Net::SSH and friends. 
 
 
 == Credits
 
-* Delano Mandelbaum (delano@solutious.com)
+* Rudy::AWS::SDB adapted from aws_sdb by Tim Dysinger (http://dysinger.net)
+* Escape, Copyright (C) 2006,2007 Tanaka Akira  <akr@fsij.org>
 * Keshia Knight Pulliam (rudy@solutious.com)
-  
+* Delano Mandelbaum (delano@solutious.com)
+
+
 == License
 
 See: LICENSE.txt

data/Rakefile

@@ -152,6 +152,7 @@ Rake::RDocTask.new do |t|
 	t.rdoc_files.include('LICENSE.txt')
 	t.rdoc_files.include('README.rdoc')
 	t.rdoc_files.include('CHANGES.txt')
+	#t.rdoc_files.include('Rudyfile')  # why is the formatting f'd?
 	t.rdoc_files.include('bin/*')
 	t.rdoc_files.include('lib/**/*.rb')
 end

data/Rudyfile

@@ -1,23 +1,26 @@
-# Rudyfile -- An example Rudy configuration. 
-#
+# = Rudy
+# 
+# This is an example Rudy configuration.
 #
 # Rudy automatically looks for configuration files in the 
-# following locations:
+# following locations (in this order):
 #
 #     ~/.rudy/config
 #     ./.rudy/config
-#     /etc/rudy/*.rb
-#     ./.rudy/*.rb
+#
 #     ./Rudyfile
 #     ./config/rudy/*.rb
+#     ./.rudy/*.rb
+#     /etc/rudy/*.rb
 #
 # When multuple files are found, the configuration is 
 # NOT OVERRIDDEN. It's ADDED / APPENDED. This means you can 
 # split configuration across many files as you please. 
 #
 # There are three sections: accounts, defaults, machines. 
+# 
 # By convention, accounts and defaults go in ~/.rudy/config or ./.rudy/config 
-# We encourage this to help avoid checking in AWS keys into source control.
+# machines configuration goes in ./Rudyfile or ./config/rudy/machines.rb
 
 
 # ---------------------------------------------------------  MACHINES  --------
@@ -25,4 +28,92 @@
 # of your environments. 
 machines do
   
+  users do
+    # If you already have private keys for logging in to your EC2 instances
+    # EC2 instances you can specify them here and Rudy will use these instead.
+    # root :keypair => "/#{Rudy.sysinfo.home}/.rudy/root-private-key"
+  end
+  
+  zone :"us-east-1b" do
+    ami 'ami-235fba4a'    # Amazon Getting Started AMI (US)
+  end
+  zone :"eu-west-1b" do
+    ami 'ami-e40f2790'    # Amazon Getting Started AMI (EU)
+  end
+
+  # We've defined an environment called "stage" with one role: "app". 
+  # The configuration inside the env block is available to all its 
+  # roles. The configuration inside the role blocks is available only
+  # to machines in that specific role. 
+  env :stage do
+    ami "ami-5394733a"    # ec2onrails/ec2onrails-v0_9_9_1-i386.manifest.xml
+    size 'm1.small'
+    
+    role :app do
+      positions 1
+      
+      # We define two disks for the stage-app machines
+      disks do
+        path "/rudy/disk1" do
+          size 2
+          device "/dev/sdr"
+        end
+        path "/rudy/disk2" do
+          size 1 
+          device "/dev/sdm"
+        end
+      end
+      
+    end
+
+    
+    role :SUCCESS do
+      
+    end
+    
+  end  
+
+  # The routines section below contains calls to local and remote
+  # scripts. The config contained in this block is made available
+  # those scripts in the form of a yaml file. The file is called
+  # rudy-config.yml. 
+  config do
+    dbmaster 'localhost'
+    newparam 573114
+  end
+  
+  
 end
+
+# ----------------------------------------------------------- ROUTINES --------
+# The routines block describes the repeatable processes for each machine group.
+routines do
+  
+  env :stage do
+    role :app do
+      
+      startup do
+        before_local Rudy.sysinfo.user => :uname
+        
+        disks do
+          create "/rudy/disk1"
+        end
+        
+        after :root => [:uname, :a]
+        after :root => [:touch, '/rudy/disk1/rudy-was-here']
+        after_local Rudy.sysinfo.user => :date
+      end
+      
+      shutdown do
+        before :root => '/a/nonexistent/script'
+        before :root => :uptime 
+        
+        disks do
+          destroy "/rudy/disk1"
+        end
+      end
+      
+    end
+  end
+end
+

data/bin/ird

@@ -8,6 +8,9 @@
 #
 
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib') # Put our local lib in first place
+$:.unshift File.join(File.dirname(__FILE__), '..', 'vendor', 'highline-1.5.1', 'lib')
+%w{drydock caesars rye}.each { |dir| $:.unshift File.join(File.dirname(__FILE__), '..', '..', dir, 'lib') }
+require 'rubygems'
 
 # SEE: http://github.com/rubyspec/matzruby/blob/a34130eb7c4ecc164115a59aa1b76c643bd98202/lib/irb/xmp.rb
 # SEE: http://github.com/blackwinter/wirble/tree/master
@@ -19,7 +22,7 @@ require 'drydock'
 require 'rudy/cli'
 
 
-module CLI
+module RudyCLI_Interactive # :nodoc:all
   extend self
   extend Drydock
   include Readline
@@ -28,7 +31,7 @@ module CLI
   global :S, :secretkey, String, "AWS Secret Access Key"
   #global :R, :region, String, "Connect to a specific EC2 region (ie: #{Rudy::DEFAULT_REGION})"
   #global :n, :nocolor, "Disable output colors"
-  global :f, :config, String, "Specify another configuration file to read (ie: #{Rudy::RUDY_CONFIG_FILE})"
+  global :f, :config, String, "Specify another configuration file to read (ie: #{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})"
@@ -46,12 +49,12 @@ module CLI
 
 
   default :interactive
-  debug :on
+  debug :off
   desc "An interactive REPL for Rudy."
   usage "#{$0} [global options]"
   command :interactive do |obj|
   
-    @@rmach = Rudy::Instances.new(:global => obj.global)
+    @@rmach = Rudy::Machines.new(:global => obj.global)
     @@rkey = Rudy::KeyPairs.new(:global => obj.global)
     @@rgrp = Rudy::Groups.new(:global => obj.global)
     @@rvol = Rudy::Volumes.new(:global => obj.global)