snapscatter 0.1.0 → 0.2.1

data/README.md

@@ -17,12 +17,13 @@ Just use the gem command to install:
 
 You can have a look at the commands and options by just typing the name of the executable:
 
-    Commands:
-      snapscatter create          # Create snapshots, optionally copying them to destination region
+    Snapscatter commands:
+      snapscatter create          # Create snapshots, optionally copying them to an alternate region
       snapscatter help [COMMAND]  # Describe available commands or one specific command
       snapscatter list            # Show available snapshots
       snapscatter purge           # purge snapshots older than the specified number of days
       snapscatter targets         # Show volumes tagged for backup
+      snapscatter version         # Shows current version of the program
 
 The best way to use this script is to make a shell wrapper for it that exports your AWS credentials
 as environment variables and then put it under the control of the cron demon.
@@ -35,7 +36,7 @@ value of `true`. You can then check the list of these volumes using the command
 ### Taking snapshots
 
 Use the command `create` to take snapshots of all the tagged volumes. Snapshots will be taken to your default
-AWS region, but you can optionally supply the '--destination' flag to create a copy onto another
+AWS region, but you can optionally supply the `--alternate` flag to create a copy onto another
 region for disaster recovery.
 
 Every snapshot taken will have the `PurgeAllow` tag set with the value of `true`. If for some reason you want
@@ -45,7 +46,10 @@ a snapshot not to be purged indefinitely, you can set this tag to any other valu
 ### Purging snapshots
 
 You can call the `purge` command to delete any snapshots older than 30 days. This is the default retention policy
-but you can change it by using the optional '-d' flag (for `--days).
+but you can change it by using the optional `-d` flag (for `--days`).
+
+Snapshots will be deleted from your default AWS region. If you supply the `--alternate` flag, snapshots will also
+be purged from the alternate region.
 
 You can also run this command with the `-n` (for `--noaction`) to only list the snapshots that would be purged
 under the specified retention policy, no snapshot will be purged.
@@ -53,8 +57,8 @@ under the specified retention policy, no snapshot will be purged.
 ### Listing snapshots
 
 The `list` command will show all the snapshots subject to be purged, that is, all snapshots with the `PurgAllow`
-tag set to `true`. The `-f`option for this command gives more information on every snapshot: snapshot id, volume id
-and date of creation.
+tag set to `true`. The `-f` option for this command gives more information on every snapshot: snapshot id, volume id
+and date of creation. Using the `-r` or `--region` flag you can change the target region.
 
 ### Consistent backups
 
@@ -77,13 +81,13 @@ Create a shell file like the following and put it under cron's control:
     export AWS_SECRET_ACCESS_KEY="YOURSECRETACCESSKEY"
 
     snapscatter purge -d 20
-    snapscatter create --destination="us-west-1"
+    snapscatter create --alternate="us-west-1"
 
 You have to make two calls because the script won't purge and create snapshots on a single call.
 
 ## TODO
 
-* Take consistency speficication out of the volume and put it in a configuration file
+* Take consistency specification out of the volume and put it in a configuration file
 * More database connectors
 
 ## Contributing

data/lib/snapscatter.rb

@@ -43,7 +43,7 @@ module Snapscatter
     snapshots = Snapscatter.list ec2
     snapshots.each do |snapshot|
       purge_date = snapshot.start_time.to_date + purge_after_days
-      # puts "#{Date.today} > #{purge_date} == #{Date.today > purge_date}"
+      # say "#{Date.today} > #{purge_date} == #{Date.today > purge_date}"
       if Date.today > purge_date
         snapshot.delete if not list_only
         purged << snapshot

data/lib/snapscatter/cli.rb

@@ -3,26 +3,34 @@ require_relative '../snapscatter'
 
 module Snapscatter
   class CLI < Thor
+    package_name "Snapscatter"
+    map "-v" => :version
+
+    desc 'version', 'Shows current version of the program'
+    def version
+      say "Snapscatter #{Snapscatter::VERSION}"
+    end
 
     desc 'targets', 'Show volumes tagged for backup'
     method_option :keys, type: :hash, banner: 'AWS security keys'
     def targets
       targets = Snapscatter.targets create_ec2
-      targets.each { |target| puts target.id }
+      targets.each { |target| say target.id }
     end
 
     desc 'list', 'Show available snapshots'
     method_option :keys, type: :hash, banner: 'AWS security keys'
     method_option :full, type: :boolean, aliases: '-f', banner: 'Show useful info about snapshots'
+    method_option :region, type: :string, aliases: '-r', banner: 'Region to list snapshots from'
     def list
-      snapshots = Snapscatter.list create_ec2
+      snapshots = Snapscatter.list create_ec2(region: options[:region])
       snapshots.each do |snapshot|
         output = [ snapshot.id ]
         if options[:full]
           output << snapshot.volume_id
           output << snapshot.start_time.strftime("%Y-%m-%d")
         end
-        puts output.join(" ")
+        say output.join(" ")
       end
     end
 
@@ -30,14 +38,20 @@ module Snapscatter
     method_option :keys, type: :hash, banner: 'AWS security keys'
     method_option :days, type: :numeric, default: 30, aliases: '-d', banner: 'retention policy in days'
     method_option :noaction, type: :boolean, default: false, aliases: '-n', banner: 'do not purge, just show'
+    method_option :alternate, type: :string, banner: 'alternate region to purge snapshots from'
     def purge
-      purged = Snapscatter.purge create_ec2, options[:days], true # options[:noaction] # remove in production
-      purged.each { |snapshot| puts "#{snapshot.id}" }
+      purged = Snapscatter.purge create_ec2, options[:days], options[:noaction]
+      purged.each { |snapshot| say "#{snapshot.id}" }
+
+      if options.has_key? 'alternate'
+        purged = Snapscatter.purge create_ec2(region: options[:alternate]), options[:days], options[:noaction]
+        purged.each { |snapshot| say "#{snapshot.id}" }
+      end
     end
 
-    desc 'create', 'Create snapshots, optionally copying them to destination region'
+    desc 'create', 'Create snapshots, optionally copying them to an alternate region'
     method_option :keys, type: :hash, banner: 'AWS security keys'
-    method_option :destination, type: :string, banner: 'region to copy snapshots to'
+    method_option :alternate, type: :string, banner: 'region to copy snapshots to'
     def create
       source_ec2 = create_ec2
       targets = Snapscatter.targets source_ec2
@@ -59,14 +73,14 @@ module Snapscatter
 
         if snapshot.status == :completed
           output = ["created", snapshot.id, description]
-          if options.has_key? 'destination'
-            destination_ec2 = create_ec2(region: options[:destination])
-            Snapscatter.copy destination_ec2, source_ec2.client.config.region, snapshot, description
-            output << "#{options[:destination]}"
+          if options.has_key? 'alternate'
+            alternate_ec2 = create_ec2(region: options[:alternate])
+            Snapscatter.copy alternate_ec2, source_ec2.client.config.region, snapshot, description
+            output << "#{options[:alternate]}"
           end
-          puts output.join(" ")
+          say output.join(" ")
         else
-          puts "#{volume.id} (#{volume_name}): snapshot failed"
+          say "#{volume.id} (#{volume_name}): snapshot failed"
         end
       end
     end

data/lib/snapscatter/version.rb

@@ -1,3 +1,3 @@
 module Snapscatter
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: snapscatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-22 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor