rds-s3-backup 0.0.1 → 0.0.2

data/README.md

@@ -1,24 +1,70 @@
 # Rds::S3::Backup
 
-TODO: Write a gem description
+The rds-s3-backup gem is a thor script that take a backup of an AWS RDS server and saves the mysqldump to an S3 bucket.
+Then it runs an obfuscation SQL script and saves the mysqldump to another S3 bucket.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+This gem is intended for use in a Chef recipe, and can be installed in your cookbook's recipe default recipe file as:
 
-    gem 'rds-s3-backup'
+    gem-package 'rds-s3-backup'
+	  action :install
+	end
 
-And then execute:
+It can be installed stand-alone as well via the usual:
 
-    $ bundle
+    gem install rds-s3-backup
 
-Or install it yourself as:
+## Usage
 
-    $ gem install rds-s3-backup
+    rds-s3-backup.rb s3-dump [options]
+	
+## Options:
+*  `--rds-instance-id=RDS_INSTANCE_ID`
+*  `--s3-bucket=S3_BUCKET`
+*  `--backup-bucket=BACKUP_BUCKET`
+*  `--s3-prefix=S3_PREFIX`
+*  `--aws-access-key-id=AWS_ACCESS_KEY_ID`
+*  `--aws-secret-access-key=AWS_SECRET_ACCESS_KEY`
+*  `--mysql-database=MYSQL_DATABASE`
+*  `--mysql-username=MYSQL_USERNAME`
+*  `--mysql-password=MYSQL_PASSWORD`
+*  `--fog-timeout=FOG_TIMEOUT`
+*  `--obfuscate-sql=OBFUSCATE_SQL`
+*  `--dump-ttl=DUMP_TTL`
+*  `--dump-directory=DUMP_DIRECTORY`
+*  `--config-file=CONFIG_FILE`
+*  `--aws-region=AWS_REGION`
+*  `--aws-s3-region=AWS_S3_REGION`
+*  `--db-subnet-group-name=DB_SUBNET_GROUP_NAME`
+*  `--db-instance-type=DB_INSTANCE_TYPE`
+*  `--instance-id=INSTANCE_ID`
+*  `--log-level=LOG_LEVEL`
 
-## Usage
+## Configuration File
+
+The configuration file, specified by `--config-file` parameter is a YAML file with tags consisting of the option names without leading dashs, and internal dashes converted to underscores. Thus:
+
+~~~~~~
+rds_instance_id: "RDS Instance ID"
+db_subnet_group_name: "Subnet Group Name"
+s3_bucket: "S3 bucket"
+aws_access_key_id: "AWS KEY"
+aws_secret_access_key: "AWS SECRET KEY"
+mysql_database: "dbname"
+mysql_username: "user"
+mysql_password: "password"
+dump_ttl: 0
+data_dog_api_key: "DDOG API"
+obfuscate_sql: "path/to/obfuscator/script.sql"
+dump_directory: "path/to/local/directory/to/hold/dumps"
+fog_timeout: 30*60
+~~~~~~
+
+and so on.
+
+Configuration file setting will override programmed defaults, and command line options will override configuration file settings.
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/bin/rds-s3-backup.rb

@@ -37,7 +37,7 @@ class RdsS3Backup < Thor
   method_option :fog_timeout, :desc => 'Timeout in seconds for Fog requests (AWS connector)'
   method_option :obfuscate_sql, :desc => 'Obfuscation Stored Procedure source'
   method_option :dump_ttl, :desc => "Number of old dumps to keep."
-  method_option :dump_directory => "Where to store the temporary sql dump file."
+  method_option :dump_directory, :desc => "Where to store the temporary sql dump file."
   method_option :config_file, :desc => "YAML file of defaults for any option. Options given during execution override these."
   method_option :aws_region, :desc => "Region of your RDS server (and S3 storage, unless aws-s3-region is specified)."
   method_option :aws_s3_region, :desc => "Region to store your S3 dumpfiles, if different from the RDS region"

data/lib/rds-s3-backup.rb

@@ -42,7 +42,7 @@ module Rds
         $logger.level = set_logger_level(@options["log_level"])
 
         $dogger = DataDog.new(@options['data_dog_api_key'])
-
+        
         "Starting RDS-S3-Backup at #{@options['timestamp']}".tap do |t|
           $logger.info t
           $dogger.send t

data/lib/rds-s3-backup/datadog.rb

@@ -24,6 +24,7 @@ module Rds
         end
 
         def make_dog_client()
+          return unless @api_key
           begin
             Dogapi::Client.new(@api_key)
           rescue Exception => e
@@ -35,7 +36,7 @@ module Rds
 
 
         def send(msg, o={})
-          return                # do nothing for testing
+          return unless @api_key
 
           return if msg.nil? || msg.empty?
 

data/lib/rds-s3-backup/version.rb

@@ -1,7 +1,7 @@
 module Rds
   module S3
     module Backup
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

data/rds-s3-backup.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |gem|
   gem.version       = Rds::S3::Backup::VERSION
   gem.authors       = ["Tamara Temple"]
   gem.email         = ["tamouse@gmail.com"]
-  gem.description   = %q{"Backup from AWS RDS snapshot to AWS S3 as mysqldump"}
+  gem.description   = %q{"Thor script and libraries to backup an AWS RDS snapshot to AWS S3, and create an obfustacted version to backup on S3 as well"}
   gem.summary       = %q{"Backup from AWS RDS snapshot to AWS S3 as mysqldump"}
-  gem.homepage      = ""
+  gem.homepage      = "https://github.com/novu/rds-s3-backup-gem"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rds-s3-backup
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-02 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -155,7 +155,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! '"Backup from AWS RDS snapshot to AWS S3 as mysqldump"'
+description: ! '"Thor script and libraries to backup an AWS RDS snapshot to AWS S3,
+  and create an obfustacted version to backup on S3 as well"'
 email:
 - tamouse@gmail.com
 executables:
@@ -183,7 +184,7 @@ files:
 - test_data/.gitignore
 - test_data/sample-config.yml
 - test_output/.gitkeep
-homepage: ''
+homepage: https://github.com/novu/rds-s3-backup-gem
 licenses: []
 post_install_message: 
 rdoc_options: []