Files | Admin

Notes:

Release Name: 0.7.0

Notes:
= Rudy - v0.7 BETA

<b>Not your grandparents' EC2 deployment tool.</b>

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_. 

When you put all this together, you have a unique name for every machine. The default machine is:

             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>).

<b>See Getting-Started[http://wiki.github.com/solutious/rudy/getting-started] for more info.</b>

<em>NOTE: This is a BETA release. That means Rudy's not ready for production use! See Project-Status[http://wiki.github.com/solutious/rudy/project-status].</em>

== Features

* Create complex environments with a single command
  * Launch multiple instances 
  * Assign elastic IP addresses
  * Create EBS volumes, attach to instances, format, and mount
  * Run scripts locally and remotely automatically
* Organize instances into environments and roles
* Powerful command-line tools
  * <tt>$ rudy -u root ssh</tt>
  * <tt>$ rudy -e testing -r database startup</tt>
* Use _any_ Amazon machine image (AMI)
* Complete command-line interface for EC2. See <tt>bin/rudy-ec2</tt>.

== Installation

Via Rubygems, one of:

    $ sudo gem install rudy
    $ sudo gem install solutious-rudy --source http://gems.github.com/

or via download:
* rudy-latest.tar.gz[http://github.com/solutious/rudy/tarball/rudy-latest]
* rudy-latest.zip[http://github.com/solutious/rudy/zipball/rudy-latest]

NOTE: <em>If you are not installing via RubyGems, you need to make sure the dependencies are in your LOAD_PATH (<tt>$:</tt>). Ryan Tomayko wrote a gist[http://gist.github.com/54177] about it.</em>

<b>See Getting-Started[http://wiki.github.com/solutious/rudy/getting-started] for more info.</b>


== Pre-Requisites

* Amazon AWS[http://aws.amazon.com/] Account
  * EC2[http://aws.amazon.com/ec2/]
  * SimpleDB[http://aws.amazon.com/simpledb/]
  * S3[http://aws.amazon.com/s3/]
* OpenSSH[http://www.openssh.com/]
* Ruby[http://ruby-lang.org] 1.8.x, 1.9.x, or JRuby[http://jruby.codehaus.org] 1.2
  * Net::SSH[http://net-ssh.rubyforge.org/]
  * Net::SCP[http://net-ssh.rubyforge.org/]
  * amazon-ec2[http://github.com/grempe/amazon-ec2]
  * aws-s3[http://github.com/marcel/aws-s3]
  * Rye[http://github.com/delano/rye]
  * Drydock[http://github.com/delano/drydock]
  * Caesars[http://github.com/delano/caesars]


== More Info

* Fork at GitHub[http://github.com/solutious/rudy]
* Read the Documentation[http://wiki.github.com/solutious/rudy]
* Submit issues to the IssueTracker[http://github.com/solutious/rudy/issues]
* Start a discussion on the GoogleGroup[http://groups.google.com/group/rudy-deployment]
* Find some Inspiration[http://www.youtube.com/watch?v=CgaiIW5Rzes]
* For all other inquires, email me directly: delano@solutious.com


== Thanks

* The Rilli.com[http://rilli.com] team
  * Adam Bognar
  * Andrew Simpson
  * Caleb Buxton
  * Colin Brumelle
* Sam Aaron
* Everyone at Utrecht.rb[http://groups.google.com/group/utrecht-rb]
* Jamis Buck for Net::SSH and friends
* Glenn Rempe for amazon-ec2
* Marcel Molina Jr. for aws-s3
* Keshia Knight Pulliam


== Contributions

I'm very open to contributions! 

* For bigger features please fork the git repo and send me a pull request. 
* For small or single file changes, send me an email with the details: <tt>delano@solutious.com</tt>


== 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>


== License

See: LICENSE.txt



Changes: RUDY, CHANGES * TODO: Remove string messages for non-string output formats * TODO: Support for reserved instances * TODO: Tests for zone and region support * TODO: Support for machine image attributes * TODO: Support for product codes * TODO: Tests for AWS HTTPS #### 0.7.0 (2009-04-??) ############################### * CHANGE: Upgrade to Drydock 0.6, Caesars 0.6, and Rye 0.6 * CHANGE: Updated Routines configuration syntax for specifying shell commands * ADDED: Releases via local git repository * ADDED: authorize and adduser directives to routines config. * ADDED: Improved CLI output for routines. * ADDED: Commands configuration for custom SSH commands * ADDED: Auto-set hostname to machine name * ADDED: Support for arbitrary routines via passthrough #### 0.6.8 (2009-04-24) ############################### * CHANGE: Renamed rudy config --rudy option to --project. This was important to maintain consistency in documentation. * CHANGE: Cleaned README. See: http://wiki.github.com/solutious/rudy #### 0.6.7 (2009-04-22) ############################### * ADDED: rudy-ec2 status can now display EU status * FIXED: Fixed bug on instance create. Instance.groups was nil, now it returns empty Array. #### 0.6.6 (2009-04-22) ############################### * ADDED: Better error handling for Rudy::AWS::SDB * FIXED: Ruby 1.9.1 compatability (including requiring aws-s3 >=0.6.1) #### 0.6.5 (2009-04-20) ############################### * FIXED: Startup and Shutdown routines now check machine group status first * FIXED: Misc release process issues between 0.6.0 and 0.6.4 * ADDED: Better error handling during startup and shutdown. * ADDED: Support for assigning addresses on startup #### 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) ############################### * CHANGE: Removed require 'rubygems' * FIXED: Resolved Drydock namespace issue for rudy and ird #### 0.5.0 (2009-04-09) ############################### NOTE: This is a significant re-write from 0.4 * 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 * ADDED: --nocolor option * ADDED: Ruby API * ADDED: Tests with 55% coverage * ADDED: Ruby API (Rudy::Machines, etc...) * ADDED: ird, a REPL (experimental) * ADDED: Now uses Rye 0.4.1 #### 0.4 (2009-03-12) ############################### NOTE: This is a significant re-write from 0.3 * CHANGE: Mostly re-written bin/ruby, moving validation to CLI 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 * ADDED: backup, disk, config * ADDED: ssh and scp commands for connecting to and copying files to/from machines * ADDED: New dependencies (trying out net-ssh) * ADDED: Domain specific language for configuration * ADDED: "Routines" for handling common actions. Starting, stopping, releasing, deploying. * ADDED: "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. * ADDED: "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. * ADDED: Extra caution when running destructive commands * ADDED: 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 * ADDED: More functionality for disks and backups * ADDED: config commands * ADDED: 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 * ADDED: All time references are converted to UTC * ADDED: Safer "Are you sure?". Number of characters to enter is commiserate with amount of danger. * ADDED: CLIs: myaddress, addresses, images, instances, disks, connect, copy, stage, backups, volumes * ADDED: Metadata storage to SimpleDB for disks, backups * ADDED: Creates EBS volumes based on startup from metadata * ADDED: Automated release process * ADDED: Automated creation of machine images * ADDED: Partial support for regions and zones * ADDED: Manage system based on security groups. * ADDED: "rudy groups" overhaul. Display, creates, destroys groups. #### 0.1 (2009-02-06) ############################### * Initial public release