fallout 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58b93407bb2b48ce39c73c4dbcc3bc770260b32e
+  data.tar.gz: d3bf1ff41fe648c677518404783c13bb1dd30bfe
+SHA512:
+  metadata.gz: 57ac6f64c67dc9db392c8ea2922eee7025ac906cd024c86c654072fe888cf002e4ea97efc28b4404ff07f5ce5947db2e687903a957d0f6dda31047bd5c0f8015
+  data.tar.gz: 23c065ae1393c703e1e6fd9e37a84f0d77ddd41d5bd758ef5ac80672925c824f186f31e93e8cc83cc45652cc9cd999465aeb63364e1fdde7782ccd22a464d5c4

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fallout.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    fallout (0.0.1)
+      aws-sdk
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  fallout!
+  rake

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

data/README.md

@@ -0,0 +1,55 @@
+# Fallout
+
+Really easy Amazon EC2 backup/restore solution.
+
+
+## Installation
+
+    $ gem install fallout
+
+## 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.
+
+Fallout supports 2 commands:
+
+### backup
+
+Syntax:
+
+`fallout backup -v <volume_id> -k <keep_days>`
+
+Example:
+
+```
+$ fallout backup -v vol-23ab3d -k 7
+
+ Deleted snapshots snap-6695b3a5, snap-ca6a3069
+ Created new snapshot snap-b67f7725, expires after 2014-09-14
+```
+
+_This will create a snapshot for the specified volume and will mark it
+as valid for 7 days. It will also delete all expired snapshots, created for the
+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
+any expired snapshots and remove them. This way you can have `fallout`
+running every day, it will keep N most fresh snapshots automatically.
+
+### restore
+
+Work in progress
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/fallout/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/fallout

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+require 'fallout'
+require 'trollop'
+
+cmd = ARGV.shift
+help = <<-EOS
+
+Fallout - Amazon EC2 backup and restore utility, version: #{Fallout::VERSION}
+
+To backup:
+  fallout backup -v <volume_id> -k <keep_days>
+
+  options:
+    -v volume id to create snapshot for
+    -k number of days to keep the snapshots
+
+  example:
+    # backup volume and keep it for 3 days
+    fallout backup -v v23dbade3 -k 3
+
+To restore:
+  fallout restore -i <instance_id> -v <volume_id>
+
+  options:
+    -i instance id to restore
+    -v volume id to restore
+
+  example:
+  # restore volume
+  fallout restore -i i39dabd -v v23dbade3
+
+EOS
+
+opts = case cmd
+when 'backup'
+  Trollop::options do
+    opt :volume, 'Volume ID', type: :string
+    opt :keep, 'Number of days to keep snapshots for', type: :integer
+  end
+when  'restore'
+  Trollop::options do
+    opt :instance, 'Instance ID', type: :string
+    opt :volume, 'Volume ID', type: :string
+  end
+else
+  puts help
+end
+
+case cmd
+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"
+    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?)
+    puts '-i and -v are required for restore'
+  else
+    Fallout::Restore.new(opts).run
+  end
+end

data/fallout.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fallout/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fallout"
+  spec.version       = Fallout::VERSION
+  spec.authors       = ["Valentin Vasilyev"]
+  spec.email         = ["valentin.vasilyev@outlook.com"]
+  spec.summary       = %q{A simple ruby script that can backup and restore Amazon EC2 instances}
+  spec.homepage      = "https://github.com/Valve/fallout"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk"
+  spec.add_dependency "trollop"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/fallout/backup.rb

@@ -0,0 +1,37 @@
+require 'aws'
+module Fallout
+  class Backup
+    EXPIRES_AFTER_KEY = 'expires_after'.freeze
+    def initialize(options)
+      @volume_id = options[:volume]
+      @keep = options[:keep].to_i
+      @expires_after = Date.today + @keep
+      @ec2 = AWS::EC2.new
+    end
+
+    def delete_expired_snapshots
+      snapshots = @ec2.snapshots.filter('volume-id', @volume_id)
+      snapshots = snapshots.map do |ss|
+        begin
+          da = Date.parse(ss.tags.to_h[EXPIRES_AFTER_KEY])
+          if da < Date.today
+            ss.delete
+            ss
+          end
+        rescue
+          next
+        end
+      end
+      snapshots.compact
+    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]
+    end
+  end
+end

data/lib/fallout/restore.rb

@@ -0,0 +1,10 @@
+module Fallout
+  class Restore
+    def initialize(options)
+    end
+
+    def run 
+      puts 'running restore with options: ' + @options.inspect
+    end
+  end
+end

data/lib/fallout/version.rb

@@ -0,0 +1,3 @@
+module Fallout
+  VERSION = "0.0.1"
+end

data/lib/fallout.rb

@@ -0,0 +1,3 @@
+require 'fallout/version'
+require 'fallout/backup'
+require 'fallout/restore'

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fallout
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Valentin Vasilyev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- valentin.vasilyev@outlook.com
+executables:
+- fallout
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/fallout
+- fallout.gemspec
+- lib/fallout.rb
+- lib/fallout/backup.rb
+- lib/fallout/restore.rb
+- lib/fallout/version.rb
+homepage: https://github.com/Valve/fallout
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A simple ruby script that can backup and restore Amazon EC2 instances
+test_files: []