fallout 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9cc2872dec9bd2ab10097d234b65e91dee35213
-  data.tar.gz: a8284867a4c97126085bc9037f4a320bb5271ee3
+  metadata.gz: 3de5840cd79fe2fba85ac073fc88d540aa0358bc
+  data.tar.gz: 59be341801bd99d5fa3defe05b2fd6e7ad4d038b
 SHA512:
-  metadata.gz: 2871346d59d5ff1e0c6aacdaf7178956e7fffca4c8baaa351adaa179622c4b3b5806089a0892ce270bcfce17dfdeaf665016fe05bb46e4ca108d1260ee4a91cc
-  data.tar.gz: f01684df05e7a6f2df809cc1ebdb62fc015f25cbad3935ba88c05a67226d7e7c554fbce30b7e2928faa8c8a7cb9d8e32e1e0d9f5b128ed103f7f04acbda75c9c
+  metadata.gz: 0e794971af26b3e7596b749ed4e5959e395559c19c26af4e404d2df86022ece03f0ccbc9f74e386da9a2ebb677d1e93409effbb02df40b8de0b72258c6bc566f
+  data.tar.gz: 62a864b134b82d5888989869a9b43f9c93a43a96e03ba9c9fbba2986ea30ea954d657a95c0ea42f659dc68143faa8ca3d50bed0dfd2569a6bfe275695c8131a2

data/Gemfile.lock

@@ -1,29 +1,27 @@
 PATH
   remote: .
   specs:
-    fallout (0.0.2)
-      aws-sdk
+    fallout (0.1.0)
+      aws-sdk (< 3)
       trollop
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aws-sdk (1.52.0)
-      aws-sdk-v1 (= 1.52.0)
-    aws-sdk-v1 (1.52.0)
-      json (~> 1.4)
-      nokogiri (>= 1.4.4)
-    json (1.8.1)
-    mini_portile (0.6.0)
-    nokogiri (1.6.3.1)
-      mini_portile (= 0.6.0)
-    rake (10.3.2)
-    trollop (2.0)
+    aws-sdk (2.1.35)
+      aws-sdk-resources (= 2.1.35)
+    aws-sdk-core (2.1.35)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.1.35)
+      aws-sdk-core (= 2.1.35)
+    jmespath (1.1.3)
+    rake (10.4.2)
+    trollop (2.1.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.5)
+  bundler
   fallout!
   rake

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Valentin Vasilyev
+Copyright (c) 2015 Valentin Vasilyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/README.md

@@ -1,7 +1,10 @@
 # Fallout
 
 Really easy Amazon EC2 backup/restore solution.
+Works by making volume snapshots periodically (with expiration)
+and taking the last snapshot when restoring.
 
+Fallout is really easy, I suggest you try it.
 
 ## Installation
 
@@ -9,10 +12,21 @@ Really easy Amazon EC2 backup/restore solution.
 
 ## Usage
 
-This gem installs `fallout` executable. Don't forget to run `rbenv`
-rehash, if you're on rbenv.
-You must have `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`
-environment variables set to authenticate with EC2.
+This gem installs `fallout` executable. Don't forget to run `rbenv` rehash, if you're on rbenv.
+
+### Required environment variables:
+
+`AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_REGION`
+
+`AWS_REGION` is required to be able to connect with AWS SDK. Specify the region of the EC2 instance you want to back up/restore.
+
+#### Optional environment variables - used in restore command only:
+
+`AWS_AVAILABILITY_ZONE` - availability zone where to create the new volume for your instance in.
+
+If you don't set it, it will default to your AWS_REGION + 'a', e.g. `eu-central-1a`.
+
+`AWS_ATTACH_VOLUME_AS_DEVICE` - will use `/dev/sda1` as default.
 
 Fallout supports 2 commands:
 
@@ -38,7 +52,7 @@ specified volume._
 #### How does expiration work?
 
 When creating a snapshot, `fallout` will tag it with a special
-`expires_after` tag. When running the backup, `fallout` will search for
+`expires_on` tag. When running the backup, `fallout` will search for
 any expired snapshots and remove them. This way you can have `fallout`
 running every day, it will keep N most fresh snapshots automatically.
 
@@ -62,7 +76,7 @@ Created new volume from the latest snapshot (vol-3942697c)
 Attached new volume to instance
 Successfully restored and started the instance with the new volume
 Instance public hostname: ec2-54-165-20-157.compute-1.amazonaws.com
-You man want to delete the old, detached volume vol-72436837 and old volume snapshots
+You may want to delete the old, detached volume vol-72436837 and old volume snapshots
 IMPORTANT: You must update your backup command to use new volume_id: vol-3942697c
 ```
 
@@ -71,16 +85,10 @@ IMPORTANT: You must update your backup command to use new volume_id: vol-3942697
 Restoring with fallout requires you to have at least 1 snapshot for the
 volume. The process will shutdown the instance, detach the root volume,
 create new volume from the latest snapshot and attach it as `/dev/sda1`
-device. Then the process will boot the instance with the new volume and
+device(can be overridden with AWS_ATTACH_VOLUME_AS_DEVICE env var).
+Then the process will boot the instance with the new volume and
 display its public hostname.
 
-##### IMPORTANT:
-
-Currently the volume will be attached as `/dev/sda1` device and created
-in `us-east-1a` zone.
-If you need this stuff to be configurable, let me know, I'll implement
-it.
-
 #### General considerations:
 
 I created this gem purely for my own purposes, we only have a handful of
@@ -90,11 +98,11 @@ I run `fallout backup` daily with cron.
 
 Contributions, tips/advices and pull requests are welcome.
 
-### Licence
+### License
 
-This code is MIT licenced:
+This code is MIT licensed:
 
-Copyright (c) 2014 Valentin Vasilyev
+Copyright (c) 2015 Valentin Vasilyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/bin/fallout

@@ -52,15 +52,19 @@ when 'backup'
   if(opts[:volume].nil? || opts[:keep].nil?)
     puts '-v and -k are required for backup'
   else
-    f = Fallout::Backup.new(opts)
-    expired_snapshots = f.delete_expired_snapshots
-    if expired_snapshots.any?
-      puts "Deleted snapshots #{expired_snapshots.map(&:id).join(', ')}"
-    else
-      puts "No expired snapshots found"
+    begin
+      f = Fallout::Backup.new(opts)
+      expired_snapshots = f.delete_expired_snapshots
+      if expired_snapshots.any?
+        puts "Deleted snapshots #{expired_snapshots.map(&:id).join(', ')}"
+      else
+        puts "No expired snapshots found"
+      end
+      new_snapshot, expires_on = f.run
+      puts "Created new snapshot #{new_snapshot.id}, expires on #{expires_on}"
+    rescue Exception => e
+      puts e.message
     end
-    new_snapshot, expires_after = f.run
-    puts "Created new snapshot #{new_snapshot.id}, expires after #{expires_after}"
   end
 when 'restore'
   if(opts[:instance].nil? || opts[:volume].nil?)
@@ -68,23 +72,26 @@ when 'restore'
   else
     begin
       r = Fallout::Restore.new(opts)
-      snapshot = r.get_latest_snapshot_for_volume(r.get_volume)
+      snapshot = r.get_latest_snapshot
+      unless snapshot
+        raise "You do not have any snapshots to restore your instance from.\n Did you run fallout backup at least once?"
+      end
       puts "Initiating omega protocol, retina scan required."
       sleep 3
-      puts "Ok, let's do it without retina, shutting down your instance."
-      instance = r.shutdown_instance
-      puts "Shut down instance successfully: #{instance.id}, status: #{instance.status}"
-      attachment = r.detach_volume(instance)
-      puts "Detached volume #{attachment.volume.id} from instance #{instance.id} successfully"
+      puts "Ok, let's do it without retina, stopping your instance."
+      instance = r.stop_instance
+      puts "Stopped instance successfully: #{instance.id}, status: #{instance.state.name}"
+      volume_attachment = r.detach_volume
+      puts "Detached volume #{volume_attachment.volume_id} from instance #{volume_attachment.instance_id} successfully"
       new_volume = r.create_volume(snapshot)
       puts "Created new volume from the latest snapshot (#{new_volume.id})"
-      r.attach_volume(new_volume, instance)
+      r.attach_volume(new_volume)
       puts "Attached new volume to instance"
-      instance = r.start_instance(instance)
+      instance = r.start_instance
       puts "Successfully restored and started the instance with the new volume"
-      puts "Instance public hostname: #{instance.dns_name}"
-      puts "You man want to delete the old, detached volume #{attachment.volume.id} and old volume snapshots"
-      puts "IMPORTANT: You must update your backup command to use new volume_id: #{new_volume.id}"
+      puts "Instance public hostname: #{Aws::EC2::Instance.new(instance.id).public_dns_name}"
+      puts "You may want to delete the old, detached volume #{volume_attachment.volume_id} and old volume snapshots"
+      puts "IMPORTANT: You must update your backup command to use the new volume_id: #{new_volume.id}"
     rescue Exception => e
       puts e.message
     end

data/fallout.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "aws-sdk", "~> 1.63"
+  spec.add_dependency "aws-sdk", "< 3"
   spec.add_dependency "trollop"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
 end

data/lib/fallout.rb

@@ -1,3 +1,6 @@
+require 'aws-sdk'
+require 'fallout/volume_utils'
+require 'fallout/instance_utils'
 require 'fallout/version'
 require 'fallout/backup'
-require 'fallout/restore'
+require 'fallout/restore'

data/lib/fallout/backup.rb

@@ -1,20 +1,23 @@
-require 'aws'
 module Fallout
   class Backup
-    EXPIRES_AFTER_KEY = 'expires_after'.freeze
+    EXPIRES_ON_KEY = 'expires_on'.freeze
+
+    include VolumeUtils
+
     def initialize(options)
       @volume_id = options[:volume]
       @keep = options[:keep].to_i
-      @expires_after = Date.today + @keep
-      @ec2 = AWS::EC2.new
+      @expires_on = Date.today + @keep
+      @volume = verify_volume_or_raise(Aws::EC2::Volume.new(@volume_id))
     end
 
     def delete_expired_snapshots
-      snapshots = @ec2.snapshots.filter('volume-id', @volume_id)
+      snapshots = @volume.snapshots
       snapshots = snapshots.map do |ss|
         begin
-          da = Date.parse(ss.tags.to_h[EXPIRES_AFTER_KEY])
-          if da < Date.today
+          tags_hash = Hash[ss.tags.map{|t| [t.key, t.value]}]
+          expires_on = Date.parse(tags_hash[EXPIRES_ON_KEY])
+          if expires_on < Date.today
             ss.delete
             ss
           end
@@ -26,12 +29,10 @@ module Fallout
     end
 
     def run
-      @volume = @ec2.volumes[@volume_id]
-      raise "Volume does not exist: #{@volume_id}" if @volume.nil? || !@volume.exists?
-      desc = "Snapshot for volume #{@volume_id}, will be deleted after #{@expires_after}"
-      snapshot = @volume.create_snapshot(desc)
-      snapshot.add_tag(EXPIRES_AFTER_KEY, value: @expires_after.to_s)
-      [snapshot, @expires_after]
+      description = "Snapshot for volume #{@volume_id}, will be deleted on #{@expires_on}"
+      snapshot = @volume.create_snapshot(description: description)
+      snapshot.create_tags(tags: [{key: EXPIRES_ON_KEY, value: @expires_on.to_s}])
+      [snapshot, @expires_on]
     end
   end
 end

data/lib/fallout/instance_utils.rb

@@ -0,0 +1,11 @@
+module Fallout
+  module InstanceUtils
+    def verify_instance_or_raise(instance)
+      if instance.nil? || !instance.exists?
+        raise "Instance does not exist: #{@instance_id}"
+      else
+        instance
+      end
+    end
+  end
+end

data/lib/fallout/restore.rb

@@ -1,76 +1,70 @@
 module Fallout
   class Restore
+    include VolumeUtils, InstanceUtils
+    attr_reader :volume
     def initialize(options)
       @instance_id = options[:instance]
+      @instance = verify_instance_or_raise(Aws::EC2::Instance.new(@instance_id))
       @volume_id = options[:volume]
-      @ec2 = AWS::EC2.new
-      @ec2_client = AWS::EC2::Client.new
+      @volume = verify_volume_or_raise(Aws::EC2::Volume.new(@volume_id))
+      @ec2 = Aws::EC2::Client.new
+      if ENV['AWS_REGION']
+        @availability_zone = ENV['AWS_AVAILABILITY_ZONE'] || "#{ENV['AWS_REGION']}a"
+      else
+        raise 'AWS_REGION is a required env variable. Please see the list of available regions at: http://goo.gl/0b2VOE'
+      end
+      @attach_as_device = ENV['AWS_ATTACH_VOLUME_AS_DEVICE'] || '/dev/sda1'
     end
 
-    def get_volume
-      @ec2.volumes[@volume_id]
+    def stop_instance
+      @instance.stop
+      @instance.wait_until_stopped
+      @instance
     end
 
-    def shutdown_instance
-      instance = @ec2.instances[@instance_id]
-      raise "Instance does not exist: #{@instance_id}" if instance.nil? || !instance.exists?
-      instance.stop
-      while instance.status != :stopped
-        sleep 1
-      end
-      instance
-    end
-
-    def start_instance(instance)
-      instance.start
-      while instance.status != :running
-        sleep 1
-      end
-      instance
+    def start_instance
+      @instance.start
+      @instance.wait_until_running
+      @instance
     end
 
-    def detach_volume(instance, device = '/dev/sda1')
-      volume = @ec2.volumes[@volume_id]
-      raise "Volume does not exist: #{volume_id}" if volume.nil? || !volume.exists?
-      attachment = volume.detach_from(instance, device)
-      while volume.status != :available
-        sleep 1
-      end
-      attachment
+    def detach_volume
+      volume_attachment = volume.detach_from_instance(instance_id: @instance_id, device: @attach_as_device)
+      @ec2.wait_until(:volume_available, volume_ids: [volume.id])
+      volume_attachment
     end
 
-    def attach_volume(volume, instance, device = '/dev/sda1')
-      volume.attach_to(instance, device)
-      while volume.status != :in_use
-        sleep 1
-      end
+    def attach_volume(volume)
+      attach_options = {instance_id: @instance_id, device: @attach_as_device}
+      volume.attach_to_instance(attach_options)
+      @ec2.wait_until(:volume_in_use, volume_ids: [volume.id])
       volume
     end
 
     def delete_volume(volume)
       volume.delete
-      while volume.status != :deleted
-        sleep 1
-      end
+      @ec2.wait_until(:volume_deleted, volume_ids: [volume.id])
       volume
     end
 
-    def get_latest_snapshot_for_volume(volume)
-      snapshots = @ec2.snapshots.filter('volume-id', @volume_id)
-      raise "No snapshots for volume #{volume.id} found, aborting restore process.\n
-      Hint: have you created a snapshot for this volume at least once?" unless snapshots.any?
-      snapshots.max_by{|ss| Date.parse(ss.tags.to_h[EXPIRES_AFTER_KEY]) rescue Date.new}
+    def get_latest_snapshot
+      snapshots = @volume.snapshots
+      unless snapshots.any?
+        raise "No snapshots for volume #{@volume.id} found, aborting restore process.\nHint: have you created a snapshot for this volume at least once?"
+      end
+      snapshots.max_by{|ss|
+        tags_hash = Hash[ss.tags.map{|t| [t.key, t.value]}]
+        Date.parse(tags_hash[EXPIRES_ON_KEY]) rescue Date.new
+      }
     end
 
-    def create_volume(snapshot, availability_zone = 'us-east-1a', volume_type: 'gp2')
-      resp = @ec2_client.create_volume(
+    def create_volume(snapshot, volume_type: 'gp2')
+      resp = @ec2.create_volume(
         snapshot_id: snapshot.id,
-        availability_zone: availability_zone,
+        availability_zone: @availability_zone,
         volume_type: volume_type)
-      volume = @ec2.volumes[resp[:volume_id]]
-      while volume.status != :available
-        sleep 1
-      end
+      volume = Aws::EC2::Volume.new(resp.volume_id)
+      @ec2.wait_until(:volume_available, volume_ids: [resp.volume_id])
       volume
     end
   end

data/lib/fallout/version.rb

@@ -1,3 +1,3 @@
 module Fallout
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/fallout/volume_utils.rb

@@ -0,0 +1,11 @@
+module Fallout
+  module VolumeUtils
+    def verify_volume_or_raise(volume)
+      unless %w(in-use available).include?(volume.state)
+        raise "Volume #{volume.id} does not exist or not in a valid state. Valid states are 'in-use' or 'available'"
+      else
+        volume
+      end
+    end
+  end
+end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: fallout
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Valentin Vasilyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.63'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.63'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,8 +84,10 @@ files:
 - fallout.gemspec
 - lib/fallout.rb
 - lib/fallout/backup.rb
+- lib/fallout/instance_utils.rb
 - lib/fallout/restore.rb
 - lib/fallout/version.rb
+- lib/fallout/volume_utils.rb
 homepage: https://github.com/Valve/fallout
 licenses:
 - MIT
@@ -111,4 +113,3 @@ signing_key:
 specification_version: 4
 summary: A simple ruby script that can backup and restore Amazon EC2 instances
 test_files: []
-has_rdoc: