ebs_conductor 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "fog", "~> 0.8.2"
+gem "skeme", ">= 0"
+gem "rest_connection", ">= 0.0.21"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2011 Ryan J. Geyer
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,12 @@
+Copyright 2011 Ryan J. Geyer
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,42 @@
+= ebs_conductor
+
+The EBS Conductor is a library for managing Amazon Elastic Block Storage volumes and snapshots.  It is designed to persist a specific set of data (a "lineage") between different compute instances.
+
+EBS Conductor can be used on it's own, but it's most powerful when executed on an EC2 instance using Chef, and the ebs_conductor cookbook[https://github.com/rgeyer/cookbooks/tree/master/cookbooks/ebs_conductor]
+
+== Examples
+
+=== Attach a new 1GB blan volume in the lineage "foobar" to a linux box at /dev/sdb1
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1')
+
+=== Attach a specific snapshot to a 1GB volume in the lineage "foobar" to a linux box at /devb/sdb1
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1' {:snapshot_id => 'snap-abcd1234'})
+
+=== Snapshot the lineage "foobar", do not purge any old snapshots in the lineage
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.snapshot_lineage('foobar')
+
+=== Snapshot the lineage "foobar", and purge old snapshots so that only 7 remain
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7})
+
+=== Snapshot the lineage "foobar" from the specified volume_id
+This is useful if you're trying to start a lineage from a "naked" instance, or if you are trying to create a new lineage from an existing one
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7, :volume_id => 'vol-abcd1234'})
+
+== List of To Do Items
+* Support for stripes in a lineage
+
+== Copyright
+
+Copyright (c) 2011 Ryan Geyer. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ebs_conductor"
+  gem.homepage = "http://github.com/rgeyer/ebs_conductor"
+  gem.license = "MIT"
+  gem.summary = %Q{A RightScale/Amazon EC2 EBS library}
+  gem.description = IO.read(File.join(File.dirname(__FILE__), "README.rdoc"))
+  gem.email = "me@ryangeyer.com"
+  gem.authors = ["Ryan Geyer"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ebs_conductor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/ebs_conductor.gemspec

@@ -0,0 +1,112 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ebs_conductor}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ryan Geyer"]
+  s.date = %q{2011-06-02}
+  s.description = %q{= ebs_conductor
+
+The EBS Conductor is a library for managing Amazon Elastic Block Storage volumes and snapshots.  It is designed to persist a specific set of data (a "lineage") between different compute instances.
+
+EBS Conductor can be used on it's own, but it's most powerful when executed on an EC2 instance using Chef, and the ebs_conductor cookbook[https://github.com/rgeyer/cookbooks/tree/master/cookbooks/ebs_conductor]
+
+== Examples
+
+=== Attach a new 1GB blan volume in the lineage "foobar" to a linux box at /dev/sdb1
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1')
+
+=== Attach a specific snapshot to a 1GB volume in the lineage "foobar" to a linux box at /devb/sdb1
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1' {:snapshot_id => 'snap-abcd1234'})
+
+=== Snapshot the lineage "foobar", do not purge any old snapshots in the lineage
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.snapshot_lineage('foobar')
+
+=== Snapshot the lineage "foobar", and purge old snapshots so that only 7 remain
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7})
+
+=== Snapshot the lineage "foobar" from the specified volume_id
+This is useful if you're trying to start a lineage from a "naked" instance, or if you are trying to create a new lineage from an existing one
+
+    ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+    ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7, :volume_id => 'vol-abcd1234'})
+
+== List of To Do Items
+* Support for stripes in a lineage
+
+== Copyright
+
+Copyright (c) 2011 Ryan Geyer. See LICENSE.txt for
+further details.
+
+}
+  s.email = %q{me@ryangeyer.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "LICENSE.txt",
+    "NOTICE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ebs_conductor.gemspec",
+    "lib/ebs_conductor.rb",
+    "test/helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rgeyer/ebs_conductor}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{A RightScale/Amazon EC2 EBS library}
+  s.test_files = [
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fog>, ["~> 0.8.2"])
+      s.add_runtime_dependency(%q<skeme>, [">= 0"])
+      s.add_runtime_dependency(%q<rest_connection>, [">= 0.0.21"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<fog>, ["~> 0.8.2"])
+      s.add_dependency(%q<skeme>, [">= 0"])
+      s.add_dependency(%q<rest_connection>, [">= 0.0.21"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fog>, ["~> 0.8.2"])
+    s.add_dependency(%q<skeme>, [">= 0"])
+    s.add_dependency(%q<rest_connection>, [">= 0.0.21"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/ebs_conductor.rb

@@ -0,0 +1,356 @@
+#  Copyright 2011 Ryan J. Geyer
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+require 'skeme'
+require 'fog'
+require 'rest_connection'
+require 'yaml'
+
+module Rgeyer
+  module Gem
+    class EbsConductor
+      @@skeme = nil
+      @@fog_aws_computes = {}
+      @@have_rs = false
+      @@logger = nil
+      @@default_timeout = 5*60
+      @@timeout_backoff = [2,5,10,15]
+
+      # Instantiates a new EbsConductor
+      #
+      # Amazon Web Services (AWS) credentials are required.  RightScale credentials are optional, if provided all
+      # objects (volumes & snapshots) will be tagged in both EC2 and RightScale
+      #
+      # == Parameters
+      # * *aws_access_key_id* : The access key ID for the AWS API.
+      # * *aws_secret_access_key* : The secret access key (password) for the AWS API.
+      #
+      # === Options
+      # * :rs_email => 'foo@bar.baz' : The email address of a RightScale user with permissions to tag volumes & snapshots
+      # * :rs_pass => 'supersecret' : The password of a RightScale user with permissions to tag volumes & snapshots
+      # * :rs_acct_num => 123456 : Your RightScale account number
+      # * :logger => A logger object
+      #
+      # == Examples
+      # Create an EBS conductor which will only tag objects in EC2
+      #     Rgeyer::Gem::EbsConductor.new('...','...')
+      #
+      # Create an EBS conductor which will tag objects in EC2 and RightScale
+      #     Rgeyer::Gem::EbsConductor.new('...','...',{:rs_email => '...', :rs_pass => '...', :rs_acct_num => 123456})
+      #
+      # Create an EBS conductor which will tag objects in EC2 and RightScale, and log to Chef::Log
+      #     Rgeyer::Gem::EbsConductor.new('...','...',{:rs_email => '...', :rs_pass => '...', :rs_acct_num => 123456, :logger => Chef::Log })
+      #
+      def initialize(aws_access_key_id, aws_secret_access_key, options={:rs_email => nil, :rs_pass => nil, :rs_acct_num => nil})
+        if options[:logger]
+          @@logger = options[:logger]
+        else
+          @@logger = Logger.new(STDOUT)
+        end
+
+        @@skeme = Skeme::Skeme.new({
+          :aws_access_key_id => aws_access_key_id,
+          :aws_secret_access_key => aws_secret_access_key,
+          :rs_email => options[:rs_email],
+          :rs_pass => options[:rs_pass],
+          :rs_acct_num => options[:rs_acct_num]
+        })
+
+        if options[:rs_email] && options[:rs_pass] && options[:rs_acct_num]
+          ::RightScale::Api::BaseExtend.class_eval <<-EOF
+          @@connection ||= RestConnection::Connection.new
+            @@connection.settings = {
+              :user => "#{options[:rs_email]}",
+              :pass => "#{options[:rs_pass]}",
+              :api_url => "https://my.rightscale.com/api/acct/#{options[:rs_acct_num]}",
+              :common_headers => {
+                "X_API_VERSION" => "1.0"
+              }
+            }
+          EOF
+          ::RightScale::Api::Base.class_eval <<-EOF
+          @@connection ||= RestConnection::Connection.new
+            @@connection.settings = {
+              :user => "#{options[:rs_email]}",
+              :pass => "#{options[:rs_pass]}",
+              :api_url => "https://my.rightscale.com/api/acct/#{options[:rs_acct_num]}",
+              :common_headers => {
+                "X_API_VERSION" => "1.0"
+              }
+            }
+          EOF
+
+          @@have_rs = true
+        end
+
+        fog_aws_compute = Fog::Compute.new({:aws_access_key_id => aws_access_key_id, :aws_secret_access_key => aws_secret_access_key, :provider => 'AWS'})
+        fog_aws_compute.describe_regions.body['regionInfo'].each do |region|
+          @@fog_aws_computes.store(region['regionName'],
+            Fog::Compute.new({
+              :aws_access_key_id => aws_access_key_id,
+              :aws_secret_access_key => aws_secret_access_key,
+              :provider => 'AWS',
+              :host => region['regionEndpoint']
+            })
+          )
+        end
+      end
+
+      # Attaches a volume from the specified lineage to the specified EC2 instance.
+      #
+      # The source of the new volume is as follows (in order of preference)
+      # * A new volume from the :snapshot_id option (if supplied)
+      # * The newest snapshot created by ebs_conductor for the specified lineage, provided it is in the same region as the server
+      # * A new blank volume
+      #
+      # == Parameters
+      # * *instance_id* : The AWS id of the server instance which should have the new volume attached.  I.E. i-[0-9a-z]{8}
+      # * *lineage* : The name of the lineage to attach.  *NOTE*: The lineage must be unique to an AWS account to avoid problems!
+      # * *size_in_gb* : The size of the new volume, measured in gigabytes (GB)
+      # * *device* : A valid device that the new volume will be attached to.  For Windows this is xvdf - xvdp, and for Linux it is /dev/sdb - /dev/sdp
+      #
+      # === Options
+      # * :timeout => @@default_timeout : The timeout in seconds before EBS conductor should stop waiting for a volume to be created and attached.  The default is 5 minutes
+      # * :snapshot_id => '...' : The AWS ID of a snapshot to create the new volume from.  I.E. snap-[0-9a-z]{8}
+      # * :tags => [] : An array of strings which will be applied as additional tags to the new volume.  I.E. ["foo:bar=baz", "database:name=sweet"]
+      #
+      # == Examples
+      # All examples assume that a new EBS conductor has been created and is assigned to *ebs_conductor*
+      #     ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      #
+      # Attach a new 1GB blank volume in the lineage "foobar" to a linux box at /dev/sdb1
+      #     ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1')
+      #
+      # Attach a specific snapshot to a 1GB volume in the lineage "foobar" to a linux box at /devb/sdb1
+      #     ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1' {:snapshot_id => 'snap-abcd1234'})
+      #
+      def attach_from_lineage(instance_id, lineage, size_in_gb, device, options={:timeout => @@default_timeout, :snapshot_id => nil, :tags => nil})
+
+        lineage_tag_key = lineage_tag(lineage)
+
+        server_hash = find_instance_by_id(instance_id)
+        if !server_hash
+          raise "Instance #{instance_id} was not found!"
+        end
+        server = server_hash[:server]
+        region = server_hash[:region]
+
+        snapshot_id = options[:snapshot_id]
+        if !options[:snapshot_id]
+          snapshots_in_lineage = @@fog_aws_computes[region].snapshots.select { |snap| snap.tags.keys.include? lineage_tag_key }
+          if snapshots_in_lineage && snapshots_in_lineage.count
+            latest_snap = snapshots_in_lineage.sort! { |a,b| b.created_at <=> a.created_at }.first
+            if latest_snap
+              snapshot_id = latest_snap.id
+            end
+          end
+        end
+
+        new_vol = server.volumes.new({:snapshot_id => snapshot_id, :size => size_in_gb, :device => device})
+        new_vol.save()
+
+        timeout_message = "Timed out waiting for EBS volume to be created and attached to (#{server.id}).  Elapsed time was #{options[:timeout]} seconds"
+        block_until_timeout(timeout_message, options[:timeout]) {
+          keep_baking = false
+          server = @@fog_aws_computes[region].servers.get(instance_id)
+          # Check things out on AWS
+          check_vol = server.block_device_mapping.select { |dev| dev['volumeId'] == new_vol.id }.first
+          keep_baking = true if !check_vol || check_vol['status'] != "attached"
+
+          # Check things out in RS if we've got RS credentials
+          if @@have_rs
+            vol = Ec2EbsVolume.find(:first) { |vol| vol.aws_id == new_vol.id }
+            keep_baking = (vol == nil)
+          end
+
+          keep_baking
+        }
+
+        @@skeme.set_tag({:ec2_ebs_volume_id => new_vol.id, :tag => lineage_tag(lineage)})
+        if options[:tags] && options[:tags].kind_of?(Array)
+          options[:tags].each do |tag|
+            @@skeme.set_tag({:ec2_ebs_volume_id => new_vol.id, :tag => tag})
+          end
+        end
+
+        new_vol.id
+      end
+
+      # Creates a new snapshot of the specified lineage.  Optionally purges previous snapshots in the lineage based on the :history_to_keep option
+      #
+      # == Parameters
+      # * *lineage*: The name of the lineage to snapshot.  *NOTE*: The lineage must be unique to an AWS account to avoid problems!
+      #
+      # === Options
+      # * :timeout => @@default_timeout : The timeout in seconds before EBS conductor should stop waiting for a volume to be created and attached.  The default is 5 minutes
+      # * :volume_id => '...' : The AWS ID of a volume to create the snapshot of.  I.E. vol-[0-9a-z]{8}
+      # * :history_to_keep => 7 : If supplied only :history_to_keep snapshots will be kept for the lineage.  If there are more than :history_to_keep snapshots for the lineage, the oldest ones are deleted
+      # * :tags => [] : An array of strings which will be applied as additional tags to the new snapshot.  I.E. ["foo:bar=baz", "database:name=sweet"]
+      #
+      # == Examples
+      # All examples assume that a new EBS conductor has been created and is assigned to *ebs_conductor*
+      #     ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      #
+      # Snapshot the lineage "foobar", do not purge any old snapshots in the lineage
+      #     ebs_conductor.snapshot_lineage('foobar')
+      #
+      # Snapshot the lineage "foobar", and purge old snapshots so that only 7 remain
+      #     ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7})
+      #
+      # Snapshot the lineage "foobar" from the specified volume_id.  This is useful if you're trying to start a lineage from a "naked" instance, or if you are trying to create a new lineage from an existing one
+      #     ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7, :volume_id => 'vol-abcd1234'})
+      #
+      def snapshot_lineage(lineage, options={:timeout => @@default_timeout, :volume_id => nil, :history_to_keep => nil, :tags => nil})
+        vol_hash = {}
+        tag_hash ={}
+        if options[:volume_id]
+          vol_by_id = find_volume_by_id(options[:volume_id])
+          vol_hash[vol_by_id[:region]] = [vol_by_id[:volume]]
+        else
+          vol_hash = find_volumes_by_lineage(lineage)
+        end
+
+        vol_hash.each do |region,vols|
+          # TODO: warn about multiples in a region?
+          vols.each do |vol|
+            if ["available", "in-use"].include? vol.status
+              description = "Created by EBS Conductor for the (#{lineage}) lineage while the volume was #{vol.server_id ? "attached to #{vol.server_id}" : "detatched"}"
+
+              excon_resp = @@fog_aws_computes[region].create_snapshot(vol.id, description)
+              snapshot_id = excon_resp.body['snapshotId']
+
+              tags = options[:tags] || []
+              tags << lineage_tag(lineage)
+              tag_hash[snapshot_id] = {:snapshot_tags => tags, :volume_tags => vol.tags.keys}
+            else
+              @@logger.warn("Volume (#{vol.id}) had a status of (#{vol.status}).  A snapshot could not be created..")
+            end
+          end
+        end
+
+        timeout_message = "Timed out waiting for EBS snapshots to start from volumes [#{vol_hash.collect{|key,val| val}}].  Elapsed time was #{options[:timeout]}"
+        block_until_timeout(timeout_message, options[:timeout]) {
+          keep_baking = false
+
+          if @@have_rs
+            snaps = Ec2EbsSnapshot.find(:all) { |snap| tag_hash.keys.include? snap.aws_id }
+            keep_baking = (snaps.count != tag_hash.keys.count)
+          end
+
+          keep_baking
+        }
+
+        # TODO: check for existing lineage which may be getting overwritten. Maybe warn, maybe just tag accordingly?
+        tag_hash.each do |key,val|
+          val[:snapshot_tags].each do |tag|
+            @@skeme.set_tag(:ec2_ebs_snapshot_id => key, :tag => tag)
+          end
+        end
+
+        if options[:history_to_keep] && options[:history_to_keep].kind_of?(Integer)
+          @@fog_aws_computes.keys.each do |region|
+            snaps = find_snapshots_in_lineage(lineage, {:region => region})
+            snaps.each do |key,val|
+              val.sort! { |a,b| a.created_at <=> b.created_at }
+              delete_count = (val.count - options[:history_to_keep])-1
+              (0..delete_count).each do |idx|
+                vol = val[idx]
+                vol.destroy
+                @@logger.info("Deleted snapshot #{vol.id}")
+              end unless delete_count <= -1
+            end
+          end
+        end
+      end
+
+      private
+
+      def find_instance_by_id(instance_id)
+        @@fog_aws_computes.each do |key,val|
+          srv = val.servers.get(instance_id)
+          if srv
+            return { :server => srv, :region => key }
+          end
+        end
+        nil
+      end
+
+      def find_volume_by_id(volume_id, options={:region => nil})
+        if options[:region]
+          return {:volume => @@fog_aws_computes[options[:region]].volumes.get(volume_id), :region => options[:region]}
+        else
+          @@fog_aws_computes.each do |key,val|
+            vol = val.volumes.get(volume_id)
+            if vol
+              return {:volume => vol, :region => key}
+            end
+          end
+        end
+
+        nil
+      end
+
+      def find_volumes_by_lineage(lineage)
+        vols = {}
+        @@fog_aws_computes.each do |key,val|
+          volz = val.volumes
+          vols[key] = volz.all('tag-key' => lineage_tag(lineage))
+        end
+
+        vols
+      end
+
+      def find_snapshots_in_lineage(lineage, options={:region => nil})
+        snaps = {}
+        if options[:region] != nil
+          snapshots_in_lineage = @@fog_aws_computes[options[:region]].snapshots.all('tag-key' => lineage_tag(lineage))
+          if snapshots_in_lineage
+            snaps[options[:region]] = snapshots_in_lineage
+          end
+        else
+          @@fog_aws_computes.each do |region,compute|
+            snapshots_in_lineage = compute.snapshots.all('tag-key' => lineage_tag(lineage))
+            if snapshots_in_lineage
+              snaps[region] = snapshots_in_lineage
+            end
+          end
+        end
+
+        snaps
+      end
+
+      def block_until_timeout(timeout_message, timeout, &block)
+        begin
+          idx=0
+          Timeout::timeout(timeout) do
+            while true
+              if yield
+                sleep @@timeout_backoff[idx] || @@timeout_backoff.last
+                idx += 1
+              else
+                break
+              end
+            end
+          end
+        rescue Timeout::Error
+          raise timeout_message
+        end
+      end
+
+      def lineage_tag(lineage)
+        "ebs_conductor:lineage=#{lineage}"
+      end
+
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ebs_conductor'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,224 @@
+--- !ruby/object:Gem::Specification 
+name: ebs_conductor
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ryan Geyer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  name: fog
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: skeme
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :runtime
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 53
+        segments: 
+        - 0
+        - 0
+        - 21
+        version: 0.0.21
+  name: rest_connection
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  name: jeweler
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rcov
+  version_requirements: *id007
+description: |+
+  = ebs_conductor
+  
+  The EBS Conductor is a library for managing Amazon Elastic Block Storage volumes and snapshots.  It is designed to persist a specific set of data (a "lineage") between different compute instances.
+  
+  EBS Conductor can be used on it's own, but it's most powerful when executed on an EC2 instance using Chef, and the ebs_conductor cookbook[https://github.com/rgeyer/cookbooks/tree/master/cookbooks/ebs_conductor]
+  
+  == Examples
+  
+  === Attach a new 1GB blan volume in the lineage "foobar" to a linux box at /dev/sdb1
+  
+      ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1')
+  
+  === Attach a specific snapshot to a 1GB volume in the lineage "foobar" to a linux box at /devb/sdb1
+  
+      ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      ebs_conductor.attach_from_lineage('i-abcd1234', 'foobar', 1, '/dev/sdb1' {:snapshot_id => 'snap-abcd1234'})
+  
+  === Snapshot the lineage "foobar", do not purge any old snapshots in the lineage
+  
+      ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      ebs_conductor.snapshot_lineage('foobar')
+  
+  === Snapshot the lineage "foobar", and purge old snapshots so that only 7 remain
+  
+      ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7})
+  
+  === Snapshot the lineage "foobar" from the specified volume_id
+  This is useful if you're trying to start a lineage from a "naked" instance, or if you are trying to create a new lineage from an existing one
+  
+      ebs_conductor = Rgeyer::Gem::EbsConductor.new('...','...')
+      ebs_conductor.snapshot_lineage('foobar', {:history_to_keep => 7, :volume_id => 'vol-abcd1234'})
+  
+  == List of To Do Items
+  * Support for stripes in a lineage
+  
+  == Copyright
+  
+  Copyright (c) 2011 Ryan Geyer. See LICENSE.txt for
+  further details.
+  
+email: me@ryangeyer.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- LICENSE.txt
+- NOTICE
+- README.rdoc
+- Rakefile
+- VERSION
+- ebs_conductor.gemspec
+- lib/ebs_conductor.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/rgeyer/ebs_conductor
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A RightScale/Amazon EC2 EBS library
+test_files: 
+- test/helper.rb