mongolly 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2673114b4273f7cb2b9e76dfac820be156200a2b
-  data.tar.gz: 53b0137133a333b476912a4d4df01154cb25376f
+  metadata.gz: 3e4b3656a62e82093372d9bd79ed0fbff1edb236
+  data.tar.gz: fed24b679b86b489fc9f16b204bfb5d8ce9ece2e
 SHA512:
-  metadata.gz: ebb1cc2d144a477ff4c9d9fded158a9c198954d8e4dbe50f1acdf4c2113cb62a9379b4b7fb694ee51ee20dbba4f26fe4422e7ebcb303702615ffae0b1c91ddde
-  data.tar.gz: 2176c4248b46d3c1ebae1c193c113214cb24dbfdd6136fa29890b3ee28c74ad0136f615f5f6549c3d3e6eaae1ce635de9ddc67485bc69671b172e2f94aa777c7
+  metadata.gz: dee271cc8eb5c8535783835d5fb31024aa8e881bd1036eabf552618f4491fd4253ac1d2cfd18574669cbabfc6483de7c505704f7550e2432fb0c2237ec853cb4
+  data.tar.gz: 79de13b84da8ea7af451d0b11405728dd62e0aed7a46627c41ffbf1ebdd118f729a841a231feb35c32da467d43a8a51514ca066f3ebb97bfa2d7c25caa539498

data/README.md

@@ -2,9 +2,28 @@
 
 **Easy backups for EBS-based MongoDB Databases**
 
-More details coming soon.
+Mongolly is a collection of extensions to the [Mongo] Ruby driver and the [Amazon Web Services 
+Ruby SDK] that make backing up MongoDB-- even with a complex topology-- as easy as:
 
-## Installation
+`$ mongolly backup`
+
+Mongolly's namesake and patron saint is [Dolly], the world's first cloned Mammal.
+
+[Amazon Web Services Ruby SDK]: http://aws.amazon.com/sdkforruby/
+[Mongo]: https://github.com/mongodb/mongo-ruby-driver
+[Dolly]: http://en.wikipedia.org/wiki/Dolly_(sheep)
+
+Mongolly is being actively used in production, however as with anything that touches your data or is responsible for something as important as backups, you should review the code and test heavily to make sure that it works properly for you.
+
+### Prerequisites
+
+Mongolly makes the following assumptions about your MongoDB topology:
+
+1. The data files for your database are stored on EBS volumes.
+1. Your database or cluster resides within a single AWS region.
+1. Your EBS volumes are tagged with an identifier ("mongolly" by default) so that the script can properly backup the right volumes for a given instance.
+
+### Installation
 
 Add this line to your application's Gemfile:
 
@@ -12,15 +31,35 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
-Or install it yourself as:
+Or install it yourself:
 
     $ gem install mongolly
 
-## Usage
+### Usage
+
+The first time you run Mongolly, an empty configuration file will be written to `~/.mongolly`.  You *must* now review this file and add the appropriate configuration for your database.
+
+The configuration options are:
+
+* **database** - db connection string (or for a replica set, array of connection strings).  Example: `localhost:27017`
+* **db_username** - db username with administrative privileges
+* **db_password** -- db password
+* **access_key_id** -- AWS Access Key
+* **secret_access_key -- AWS Secret Key
+* **region** -- AWS Region where your cluster is located
+* **log_level** -- Logging level, `info` by default
+* **mongo_start_command** -- The command that's issued on the mongo config server to start the config DB
+* **mongo_stop_command** -- The command that's issued on the mongo config server to stop the config DB
+* **config_server_ssh_user** -- The use to ssh to the config server as
+* **config_server_ssh_keypath** -- The path to the ssh keys
+* **volume_tag** -- The tag name identifying volumes to back up.  Default is `mongolly`
+
+Once you have created your configuration file, you are now ready to backup your database.  That's as simple as:
+
+`$ mongolly backup`
 
-`mongolly help usage`
 
 ## Contributing
 
@@ -32,5 +71,7 @@ Or install it yourself as:
 
 ### Copyright
 
-Copyright (c) 2012 Michael Saffitz. See LICENSE.txt for
+Copyright (c) 2012-3 Michael Saffitz [@msaffitz](http://www.twitter.com/msaffitz)
+
+See LICENSE.txt for
 further details.

data/lib/mongolly/extensions/mongo/mongo_client.rb

@@ -6,6 +6,7 @@ require 'retries'
 class Mongo::MongoClient
   MAX_DISABLE_BALANCER_WAIT = 60*8 # 8 Minutes
   REPLICA_SNAPSHOT_THRESHOLD = 60*5 # 5 Minutes
+  REPLICA_SNAPSHOT_PREFER_HIDDEN = true
 
   def snapshot_ebs(options={})
 
@@ -32,12 +33,12 @@ class Mongo::MongoClient
         ssh_command(options[:config_server_ssh_user], config_server, options[:mongo_start_command], options[:config_server_ssh_keypath])
       end
     else
-      backup_instance(snapshot_ebs_target(REPLICA_SNAPSHOT_THRESHOLD), options, false )
+      backup_instance(snapshot_ebs_target(REPLICA_SNAPSHOT_THRESHOLD, REPLICA_SNAPSHOT_PREFER_HIDDEN), options, false )
     end
   end
 
 protected
-  def snapshot_ebs_target(threshold=nil)
+  def snapshot_ebs_target(threshold=nil, prefer_hidden=nil)
     host_port.join(':')
   end
 

data/lib/mongolly/extensions/mongo/mongo_replica_set_client.rb

@@ -2,21 +2,28 @@ require 'mongo'
 
 class Mongo::MongoReplicaSetClient
 
-  def most_current_secondary(threshold = 0)
+  def most_current_secondary(threshold = 0, prefer_hidden = true)
     replica = self['admin'].command( replSetGetStatus: 1 )
-    secondaries = replica['members'].select { |m| m['state'] == 2 }.sort_by { |m| m['name'] }
+    secondaries = replica['members'].select { |m| m['state'] == 2 }.sort_by { |m| [m['optime'], m['name']] }
     most_current = secondaries.first
-    secondaries[1..-1].each do |secondary|
-      if (secondary['optime'] - most_current['optime']) > threshold
-        most_current = secondary
+
+    hidden = self['local']['system']['replset'].find_one['members'].select { |mem| mem['hidden'] }.map { |mem| mem['host'] }
+
+    if prefer_hidden && !hidden.include?(most_current['name'])
+      secondaries[1..-1].each do |secondary|
+        if hidden.include?(secondary['name']) && (most_current['optime'] - secondary['optime']) < threshold
+          most_current = secondary
+          break
+        end
       end
     end
-    @mongolly_logger.debug("Found most current secondary #{most_current['name']}")
+
+    @mongolly_logger.debug("Found most current secondary #{most_current['name']}, hidden: #{hidden.include? most_current['name']}")
     most_current['name']
   end
 
 protected
-  def snapshot_ebs_target(threshold = 0)
-    most_current_secondary(threshold)
+  def snapshot_ebs_target(threshold = 0, prefer_hidden = true)
+    most_current_secondary(threshold, prefer_hidden)
   end
 end

data/lib/mongolly/version.rb

@@ -1,3 +1,3 @@
 module Mongolly
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/mongolly.gemspec

@@ -17,12 +17,12 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency("thor", ["~> 0.15.4"])
-  gem.add_dependency("mongo", ["~> 1.8.3"])
-  gem.add_dependency("bson_ext", ["~> 1.8.3"])
-  gem.add_dependency("aws-sdk", ["~> 1.9.5"])
+  gem.add_dependency("thor")
+  gem.add_dependency("mongo")
+  gem.add_dependency("bson_ext")
+  gem.add_dependency("aws-sdk")
   gem.add_dependency("ipaddress")
-  gem.add_dependency("net-ssh", ["~> 2.0"])
+  gem.add_dependency("net-ssh")
   gem.add_dependency("retries")
 
 end

metadata

@@ -1,71 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: mongolly
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Michael Saffitz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.15.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongo
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bson_ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aws-sdk
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.9.5
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 1.9.5
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ipaddress
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: retries
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.4
+rubygems_version: 2.1.9
 signing_key: 
 specification_version: 4
 summary: Easy backups for EBS-based MongoDB Databases