ec2-backup 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff55011774526499c64260a0d43975fde63d1e59
+  data.tar.gz: 4215bc6ffd251eab34fae1112bdcabb3abb10153
+SHA512:
+  metadata.gz: eabadc478c110797af49223fda452c3bddcd78959f2744fd917dfbca5fe55617cba16a4bc6a7060952d969710c4702fd3d7ccd7846bf8cf26dd372f03b54ef3d
+  data.tar.gz: ef47001adb02aab9aaae01e84601be1f806f34c9bdec98e6a6e248f04208ab21fdb61c658442467b39d8125e67c77dde939010cfe40a2b0d16e6d289911f76f8

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Alfred Moreno
+
+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,33 @@
+ec2-backup
+==========
+
+Automate backups of your infrastructure dynamically via AWS EC2 Tagging and Snapshots
+
+Installation
+==========
+
+`gem install ec2-backup`
+
+Configuration
+==========
+
+* accounts - An array of accounts you wish to configure backups for
+
+Each account has a key for the name of the account followed by the
+`access_key_id` and `secret_access_key` for the account
+
+* hourly_snapshots - The amount of hourly snapshots to retain
+* daily_snapshots - The amount of daily snapshots to retain
+* weekly_snapshots - The amount of weekly snapshots to retain
+* monthly_snapshots - The amount of monthly snapshots to retain
+
+* tags - The AWS EC2 Tags used for finding instances to be snapshotted.
+
+Usage
+==========
+
+Create a `ec2-backup.yml` as shown in the example file in the repository
+and place it in your home directory as `.ec2-backup.yml`
+
+When you're ready to start backing up your instances, execute the
+`ec2-backup` command from your terminal.

data/bin/ec2-backup

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'ec2-backup'
+
+backup = Ec2Backup.new
+backup.start

data/ec2-backup.example.yml

@@ -0,0 +1,19 @@
+
+accounts:
+  production:
+    access_key_id: ''
+    secret_access_key: ''
+  corporate:
+    access_key_id: ''
+    secret_access_key: ''
+  testing:
+    access_key_id: ''
+    secret_access_key: ''
+
+hourly_snapshots: 24
+daily_snapshots: 30
+weekly_snapshots: 4
+monthly_snapshots: 12
+
+tags:
+  backup: 'true'

data/ec2-backup.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ec2-backup/ec2-backup'
+
+Gem::Specification.new do |gem|
+  gem.name          = "ec2-backup"
+  gem.version       = '1.0.0'
+  gem.authors       = ["Alfred Moreno"]
+  gem.email         = ["kryptek@gmail.com"]
+  gem.description   = %q{Automate backups of your infrastructure dynamically via AWS EC2 Tagging and Snapshots}
+  gem.summary       = %q{A configurable backup gem for ec2 volumes. See the github page for more}
+  gem.homepage      = "https://github.com/kryptek/ec2-backup"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'active_support'
+  gem.add_dependency 'fog'
+
+  gem.license       = 'MIT'
+end

data/lib/ec2-backup.rb

@@ -0,0 +1,5 @@
+__LIB_DIR__ = File.expand_path(File.dirname(__FILE__))
+$LOAD_PATH.unshift __LIB_DIR__ unless $LOAD_PATH.include?(__LIB_DIR__)
+
+require 'ec2-backup/ec2-backup'
+

data/lib/ec2-backup/ec2-backup.rb

@@ -0,0 +1,246 @@
+require 'active_support/all'
+require 'fog'
+
+class Ec2Backup
+  def initialize
+
+    @settings = YAML.load_file("#{ENV['HOME']}/.ec2-backup.yml")
+
+    @hourly_snapshots  = @settings['hourly_snapshots']
+    @daily_snapshots   = @settings['daily_snapshots']
+    @weekly_snapshots  = @settings['weekly_snapshots']
+    @monthly_snapshots = @settings['monthly_snapshots']
+    @tags              = @settings['tags']
+
+  end
+
+  ###############################################################################
+  # def log
+  #
+  # Purpose: Neatly logs events to the screen
+  # Parameters:
+  #   text<~String>: The text to log to the screen
+  # Returns:
+  #   <~String> - Full line of text
+  ###############################################################################
+  def log(text)
+    puts "[#{Time.now}] \e[0;30mCaller: #{caller[0][/`(.*)'/,1]} \e[0m| #{text}"
+  end
+
+  ###############################################################################
+  # def ec2
+  #
+  # Purpose: Connects to the Amazon API
+  # Parameters: None
+  # Returns: Fog::Compute::AWS
+  ###############################################################################
+  def ec2
+    Fog::Compute::AWS.new(aws_access_key_id: @aws_access_key_id, aws_secret_access_key: @aws_secret_access_key)
+  end
+
+  ###############################################################################
+  # def volume_snapshots
+  #
+  # Purpose: Returns all snapshots associated with an EBS volume id
+  # Parameters:
+  #   volume_id<~String>: The volume id of the EBS volume
+  # Returns: <~Array>
+  #           Fog::AWS::Snapshot
+  ###############################################################################
+  def volume_snapshots(volume_id)
+    ec2.snapshots.select { |snapshot| snapshot.volume_id == volume_id }
+  end
+
+  ###############################################################################
+  # def find_instances
+  #
+  # Purpose: Returns all servers with matching key-value tags
+  # Parameters:
+  #   tags<~Hash>: key-value pairs of tags to match against EC2 instances
+  # Returns: <~Array>
+  #           Fog::Compute::AWS::Server
+  #
+  ###############################################################################
+  def find_instances(tags)
+    attempts = 0
+    begin
+      ec2.servers.select { |server| tags.reject { |k,v| server.tags[k] == tags[k] }.empty? }
+    rescue Excon::Errors::ServiceUnavailable
+      sleep 5
+      attempts += 1
+      return [] if attempts == 5
+      retry
+    end
+  end
+
+  ###############################################################################
+  # def create_snapshot
+  #
+  # Purpose: Creates an EBS snapshot
+  # Parameters:
+  #   options<~Hash>
+  #     volume_id<~String>: The volume id to snapshot
+  #     description<~String>: The description of the snapshot
+  #     snapshot_type<~String>: The type of snapshot being created (hourly, etc)
+  #     tags<~Hash>: Key-value pairs of tags to apply to the snapshot
+  # Returns: nil
+  ###############################################################################
+  def create_snapshot(options)
+    snapshot = ec2.snapshots.new
+    snapshot.volume_id = options['volume_id']
+    snapshot.description = options['description']
+
+    attempts = 0
+
+    begin
+      snapshot.save
+      snapshot.reload
+    rescue Fog::Compute::AWS::Error
+      sleep 5
+      attempts += 1
+      if attempts == 5
+        log "Error communicating with API; Unable to save volume `#{options['volume_id']}` (Desc: #{options['description']})"
+      end
+      return unless attempts == 5
+    end
+
+    options['tags'].each do |k,v|
+      begin
+        ec2.tags.create({resource_id: snapshot.id, key: k, value: v})
+      rescue Errno::EINPROGRESS , Errno::EISCONN
+        log "API Connection Error"
+        sleep 1
+        retry
+      rescue Fog::Compute::AWS::Error
+        log "Failed attaching tag `'#{k}' => #{v}` to #{options['snapshot_type']} snapshot #{snapshot.id}"
+        sleep 1
+        retry
+      end
+    end
+
+  end
+
+  ###############################################################################
+  # def delete_snapshot
+  #
+  # Purpose: Delete an EBS snapshot from Amazon EC2
+  # Parameters:
+  #   snapshot_id<~String>: The id of the snapshot to be deleted
+  # Returns: nil
+  ###############################################################################
+  def delete_snapshot(snapshot_id)
+    log "\e[0;31m:: Deleting snapshot:\e[0m #{snapshot_id}"
+
+    begin
+      ec2.delete_snapshot(snapshot_id)
+      sleep 0.2
+    rescue Fog::Compute::AWS::NotFound
+      log "Failed to delete snapshot: #{snapshot_id}; setting { 'protected' => true }"
+      ec2.tags.create({resource_id: snapshot_id, key: 'protected', value: 'true'})
+    rescue Fog::Compute::AWS::Error
+      log "API Error"
+    end
+
+  end
+
+  ###############################################################################
+  # def too_soon?
+  #
+  # Purpose: Determines if enough time has passed between taking snapshots
+  # Parameters:
+  #   history<~Array>
+  #     Fog::Compute::AWS::Snapshot: Volume snapshot
+  #   snapshot_type<~String>: The type of snapshot (hourly, etc)
+  # Returns: Boolean
+  ###############################################################################
+  def too_soon?(history,snapshot_type)
+
+    # If the backup history size is zero,
+    # the server doesn't have any backups yet.
+    return false if history.size == 0
+
+    elapsed = Time.now - history.last.created_at
+
+    case snapshot_type
+    when 'hourly'
+      elapsed < 1.hour
+    when 'daily'
+      elapsed < 1.day
+    when 'weekly'
+      elapsed < 1.week
+    when 'monthly'
+      elapsed < 1.month
+    end
+
+  end
+
+  ###############################################################################
+  # def start
+  #
+  # Purpose: Start the backup process
+  # Parameters: none
+  # Returns: nil
+  ###############################################################################
+  def start
+
+    @settings['accounts'].each do |account,keys|
+
+      puts "Account: #{account}"
+      @aws_access_key_id     = keys['access_key_id']
+      @aws_secret_access_key = keys['secret_access_key']
+
+      # Find all servers with tags matching the supplied Hash
+      find_instances(@tags).each do |server|
+
+        # Begin snapshotting each volume attached to the server
+        #
+        server.block_device_mapping.each do |block_device|
+
+          log "\e[0;32m Searching for matching snapshots \e[0m(#{server.id}:#{block_device}).."
+          snapshots = volume_snapshots(block_device['volumeId'])
+
+          # Create each type of backup we'll be using
+          #
+          %w(hourly daily weekly monthly).each do |snapshot_type|
+
+            # Build snapshot history for the working volume and return all snapshots
+            # matching our particular snapshot type
+            history = snapshots.select do |snapshot|
+              snapshot.tags['snapshot_type'] == snapshot_type  &&
+                snapshot.tags['volume_id'] == block_device['volumeId'] &&
+                snapshot.tags['protected'] == 'false'
+            end
+
+            history.sort_by! { |snapshot| snapshot.created_at }
+
+            unless too_soon?(history,snapshot_type) || instance_variable_get("@#{snapshot_type}_snapshots") == 0
+
+              # Check against threshold limits for backup history and delete as needed
+              #
+              while history.size >= instance_variable_get("@#{snapshot_type}_snapshots")
+                delete_snapshot(history.first.id)
+                history.delete(history.first)
+              end
+
+              log "Creating #{snapshot_type} for #{block_device['volumeId']}.."
+              create_snapshot({
+                'volume_id'     => block_device['volumeId'],
+                'snapshot_type' => snapshot_type,
+                'description'   => "Snapshot::#{snapshot_type.capitalize}> Server: #{server.id}",
+                'tags'          => {
+                  'snapshot_time' => "#{Time.now}",
+                  'snapshot_type' => snapshot_type,
+                  'instance_id'   => server.id,
+                  'volume_id'     => block_device['volumeId'],
+                  'deviceName'    => block_device['deviceName'],
+                  'protected'     => 'false'
+                }
+              })
+            end
+          end
+        end
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: ec2-backup
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alfred Moreno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: active_support
+  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: fog
+  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'
+description: Automate backups of your infrastructure dynamically via AWS EC2 Tagging
+  and Snapshots
+email:
+- kryptek@gmail.com
+executables:
+- ec2-backup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- LICENSE
+- README.md
+- bin/ec2-backup
+- ec2-backup.example.yml
+- ec2-backup.gemspec
+- lib/ec2-backup.rb
+- lib/ec2-backup/ec2-backup.rb
+homepage: https://github.com/kryptek/ec2-backup
+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.0.2
+signing_key: 
+specification_version: 4
+summary: A configurable backup gem for ec2 volumes. See the github page for more
+test_files: []
+has_rdoc: