vgh 0.2.1 → 0.2.2

data/.travis.yml

@@ -2,6 +2,5 @@ language: ruby
 rvm:
   - 1.9.3
   - 1.8.7
-  - ree
 script: "bundle exec rake spec"
 #script: "rvmsudo bundle exec rake spec"

data/CHANGELOG.rdoc

@@ -1,7 +1,13 @@
-=== 0.2.1
+=== 0.2.2
+[Features]
+  - Add '--example' option to generate example configuration
+  - Add option to keep a number of checkpoints
+[Bugs]
   - Fix SQL and LVM checks
+  - Clean up the Snapshot class
 
 === 0.2.0
+[Features]
   - Add Checkpoint app
   - Merged all configuration files to a single one
   - Major code refactoring

data/README.rdoc

@@ -52,9 +52,10 @@ It should have the following format (where the keys are symbols):
      :sub_key: 'sub value'
 
 An example of the configuration file can be found in this gem's directory.
-You can find were that is by specifying the +--gemdir+ command line option.
+You can copy it by using the +--example=PATH+ command line option.
 
-Ex: <tt>vgh --gemdir</tt>
+Ex: <tt>mkdir /etc/vgh
+vgh --example=/etc/vgh</tt>
 
 Read the config.yml.example for a list of configuration options.
 

data/conf/config.yml.example

@@ -14,12 +14,13 @@
 #:auto_scaling_endpoint: 'autoscaling.us-west-2.amazonaws.com'
 
 
-###########################
-# EC2-Backup app settings #
-###########################
+########################################
+# EC2-Backup & Checkpoint app settings #
+########################################
 
 # Expiration period (defaults to 7 days)
-#:expiration: 7 # Number of days to keep the snapshots
+#:expiration: 7 # Number of days to keep the backup snapshots
+#:checkpoints: 5 # How many checkpoints should be kept
 
 # MySQL Settings
 #:mysql_user: 'dbadmin' # The MySQL user that can flush the tables

data/lib/vgh/apps/checkpoint.rb

@@ -15,9 +15,13 @@ module APPS
     # @return [Object] Volumes Class
     attr_reader :volumes
 
+    # @return [Object] Snapshot Class
+    attr_reader :snapshot
+
     # Initialize external classes
     def initialize
       @volumes ||= EC2::Volume.new
+      @snapshot = EC2::Snapshot.new
     end
 
     # Runs the checkpoint app logic
@@ -25,16 +29,16 @@ module APPS
 
       System.lock
 
-      vols = volumes
-      vols.list_tagged('CHECKPOINT').map {|vid|
-        snap_and_tag(
+      volumes.list_tagged('CHECKPOINT').map {|vid|
+        snapshot.snap_and_tag(
           vid,
-          "CHECKPOINT for #{vid}(#{vols.name_tag(vid)})",
+          "CHECKPOINT for #{vid}(#{volumes.name_tag(vid)})",
           {
             'Name'   => fqdn,
-            'CHECKPOINT' => "#{instance_id};#{vid}"
+            'CHECKPOINT' => "#{vid}"
           }
         )
+        snapshot.purge_checkpoints_for vid
       }
 
       System.unlock

data/lib/vgh/apps/ec2_backup.rb

@@ -15,9 +15,13 @@ module APPS
     # @return [Object] Volumes Class
     attr_reader :volumes
 
+    # @return [Object] Snapshot Class
+    attr_reader :snapshot
+
     # Initialize external classes
     def initialize
       @volumes ||= EC2::Volume.new
+      @snapshot = EC2::Snapshot.new
     end
 
     # Runs the ec2-backup app logic
@@ -25,16 +29,16 @@ module APPS
 
       System.lock
 
-      vols = volumes
-      vols.list.map {|vid|
-        snap_and_tag(
+      volumes.list.map {|vid|
+        snapshot.snap_and_tag(
           vid,
-          "Backup for #{vid}(#{vols.name_tag(vid)})",
+          "Backup for #{vid}(#{volumes.name_tag(vid)})",
           {
             'Name'   => fqdn,
-            'BACKUP' => "#{instance_id};#{vid}"
+            'BACKUP' => "#{vid}"
           }
         )
+        snapshot.purge_backups_for vid
       }
 
       System.unlock

data/lib/vgh/cli.rb

@@ -65,7 +65,7 @@ module VGH
       confdir
       verbose
       logging
-      gemdir
+      examples
       help
       version
       validate(args)
@@ -135,10 +135,12 @@ module VGH
       end
     end
 
-    # Displays the location of gem files
-    def gemdir
-      @optparse.on_tail('-g', '--gemdir', 'Gem files location') do
-        puts File.expand_path('../../', File.dirname(__FILE__))
+    # Creates sample config folder
+    def examples
+      @optparse.on_tail('-e', '--example=PATH', 'Generate example configuration') do |path|
+        examples = Dir.glob(File.expand_path('../../conf/*', File.dirname(__FILE__)))
+        destination = File.expand_path(path)
+        FileUtils.cp examples, destination, :verbose => true
         exit
       end
     end

data/lib/vgh/ec2/snapshot.rb

@@ -1,10 +1,5 @@
 module VGH
 
-  # Creates the snapshots
-  def snap_and_tag(*args)
-    EC2::Snapshot.new(*args)
-  end
-
 module EC2
 
 # Creates a snapshot of the specified volume.
@@ -20,13 +15,11 @@ class Snapshot
   # @param [String] description The description for the new snapshot
   # @param [Hash] tags A Hash containing the names and values of the tags
   # @return [Snapshot] The Snapshot object.
-  def initialize(volume_id, description, tags)
+  def snap_and_tag(volume_id, description, tags)
     @volume_id   = volume_id
     @description = description
     @tags        = tags
     create_snapshot
-    tag_snapshot
-    purge_backups
     return snapshot
   end
 
@@ -48,6 +41,7 @@ class Snapshot
     @snapshot = ec2.volumes[volume_id].
       create_snapshot("#{description}")
     message.info "Created snapshot \"#{snapshot.id}\""
+    tag_snapshot
     return @snapshot
   end
 
@@ -61,26 +55,44 @@ class Snapshot
   end
 
   # Purges expired snapshots
-  def purge_backups
-    expired_backups.each do |snap|
+  def purge_backups_for(*args)
+    expired_backups_for(*args).each do |snap|
       message.info "Deleting expired snapshot (#{snap.id})"
       snap.delete
     end
   end
 
+  # Purges expired snapshots
+  def purge_checkpoints_for(*args)
+    expired_checkpoints_for(*args).each do |snap|
+      message.info "Deleting checkpoint (#{snap.id})"
+      snap.delete
+    end
+  end
+
   # Creates a list of expired snapshots according to the expiration time
   # specified in the app's configuration file
   # @return [Array] An array of expired snapshot objects
-  def expired_backups
+  def expired_backups_for(vid)
     @expired_backups = []
-    all_backups.each {|snap|
-      if snap.start_time < (Time.now - backup_expiration*24*60*60)
-        @expired_backups.push snap
-      end
-    }
+    all_backups.tagged('BACKUP').tagged_values(vid).
+      each {|snap|
+        if snap.start_time < (Time.now - backup_expiration*24*60*60)
+          @expired_backups.push snap
+        end
+      }
     return @expired_backups
   end
 
+  # Creates a list of checkpoints that should be purged
+  # @return [Array] An array of snapshot objects
+  def expired_checkpoints_for(vid)
+    @expired_checkpoints = all_backups.
+      tagged('CHECKPOINT').tagged_values(vid).
+      sort_by(&:start_time).reverse.
+      drop(checkpoints_to_keep)
+  end
+
   # Check for a an expiration period in the configuration file
   def backup_expiration
     expiration = config[:expiration]
@@ -92,6 +104,17 @@ class Snapshot
     return @backup_expiration.to_i
   end
 
+  # How many checkpoints should be kept
+  def checkpoints_to_keep
+    keep = config[:checkpoints]
+    if keep.nil?
+      @checkpoints_to_keep = 5
+    else
+      @checkpoints_to_keep = keep
+    end
+    return @checkpoints_to_keep.to_i
+  end
+
   # Returns a list of snapshots that are named the same with the current FQDN.
   def all_backups
     @all ||= ec2.snapshots.

data/lib/vgh/system/mysql.rb

@@ -36,7 +36,7 @@ class MySQL
   # @return [Boolean]
   def commands_present?
     commands_present = false
-    if File.exists?(@mysqladmin_cmd) and File.exists?(@mysqladmin_cmd)
+    if File.exists?(@mysqladmin_cmd) and File.exists?(@mysql_cmd)
       commands_present = true
     end
     return commands_present

data/lib/vgh/version.rb

@@ -1,6 +1,6 @@
 module VGH
   # Version number
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 
   # Returns the version number
   def version

data/spec/ec2/snapshot_spec.rb

@@ -27,9 +27,15 @@ describe VGH::EC2::Snapshot do
   end
 
   it "Should create a list of expired backups" do
-    snap.expired_backups.should be_an Array
+    snap.expired_backups_for(@volume1.id).should be_an Array
   end
 
+  it "Should create a list of expired checkpoints" do
+    snap.stub(:config).and_return({:checkpoints => 2})
+    snap.expired_checkpoints_for(@volume1.id).should be_an Array
+  end
+
+
   it "Should return a backup expiration integer" do
     snap.stub(:config).and_return({:expiration => 5})
     snap.backup_expiration.should eq(5)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vgh
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-26 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -185,7 +185,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1008001245
+      hash: -217298541
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,7 +194,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1008001245
+      hash: -217298541
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23