akupchanko-astrails-safe 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  data.tar.gz: 6d883362cf71d5a1efb2a7dcae62842a32f741dcd8c5188346d6d1eac9f3602625943ba3e7b08d2b50a2959f5901faf132927804557f76a073955f849769c8aa
+  metadata.gz: fe3a8df8e2a434c865ca80d361bc750cdc20deebe2b64581538b7c1d8f6db2a23e7eb04a13809f3d65bdb0602511bf533a7eeeb0fca8c60fbd6b2517c02f6233
+SHA1: 
+  data.tar.gz: 50b13bff3068d4d04d716d2e561353735a30f8f1
+  metadata.gz: 68c25d04ce2b671b0b035e1c5e4880db3776fdc2

data/.autotest

@@ -0,0 +1,3 @@
+Autotest.add_hook(:initialize) do |at|
+  at.add_mapping(%r{lib/astrails/safe/config/.*\.rb$}, true) {'spec/astrails/safe/config_spec.rb'}
+end

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format d
+--profile

data/CHANGELOG

@@ -0,0 +1,35 @@
+0.3.1
+
+* plain ftp support from seroy
+* mongodump support from Matt Berther
+
+0.3.0
+
+* switch to bundler
+* fixed the rspec
+
+0.2.8
+
+* ruby 1.9.2 compatibility (tests mostly)
+* code review, and tons of small fixes
+* check file size before attempting to upload to cloudfiles
+* testing framework changed from micronaut to rspec
+
+0.2.7
+
+* default options for gpg now include '--no-use-agent'
+* support for 'command' option for gpg
+* quote values in mysql password file
+* add 'lib' to $:
+* [EXPERIMENTAL] Rackspace Cloud Files support
+
+0.2.6
+
+* fix typo in the template config file. (change option to options in pgdump)
+* add example 'options' for tar in the template config file.
+* do not try to upload more then 5G of data to S3. print error instead
+
+0.2.5
+
+* Safety mesure: Disable overwrite of existing configuration keys except for multi-value keys
+  supported multi-value keys: skip_tables, exclude, files

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in akupchanko-astrails-safe.gemspec
+gemspec
+
+gem 'debugger'
+gem 'awesome_print'

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2010-2013 Astrails Ltd.
+
+MIT License
+
+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.markdown

@@ -0,0 +1,250 @@
+# astrails-safe
+
+Simple database and filesystem backups with S3 and Rackspace Cloud Files support (with optional encryption)
+
+* Home: [http://astrails.com/opensource/astrails-safe](http://astrails.com/opensource/astrails-safe)
+* Code: [http://github.com/astrails/safe](http://github.com/astrails/safe)
+* Blog: [http://astrails.com/blog/astrails-safe](http://astrails.com/blog/astrails-safe)
+
+[![Build Status](https://travis-ci.org/astrails/safe.png)](https://travis-ci.org/astrails/safe)
+[![Code Climate](https://codeclimate.com/github/astrails/safe.png)](https://codeclimate.com/github/astrails/safe)
+
+## Motivation
+
+We needed a backup solution that will satisfy the following requirements:
+
+* opensource
+* simple to install and configure
+* support for simple ‘tar’ backups of directories (with includes/excludes)
+* support for simple mysqldump of mysql databases
+* support for symmetric or public key encryption
+* support for local filesystem, Amazon S3, and Rackspace Cloud Files for storage
+* support for backup rotation. we don’t want backups filling all the diskspace or cost a fortune on S3 or Cloud Files
+
+And since we didn't find any, we wrote our own :)
+
+## Contributions
+
+The following functionality was contributed by astrails-safe users:
+
+* PostgreSQL dump using `pg_dump` (by Mark Mansour <mark@stateofflux.com>)
+* Subversion dump using svndump (by Richard Luther <richard.luther@gmail.com>)
+* SFTP remote storage (by Adam <adam@mediadrive.ca>)
+* benchmarking output (By Neer)
+* README fixes (by Bobby Wilson)
+* improved config file parsing (by Fedor Kocherga <fkocherga@gmail.com>)
+* mysql password file quoting (by Jonathan Sutherland <jonathan.sutherland@gmail.com>)
+* Rackspace Cloud Files support (by H. Wade Minter <minter@lunenburg.org>)
+* Plan FTP support (by seroy <seroy@bk.ru>)
+* mongodump support (by Matt Berther <matt@mattberther.com>)
+
+Thanks to all :)
+
+## Installation
+
+    sudo gem install astrails-safe --source http://gemcutter.org
+
+## Reporting problems
+
+Please report problems at the [Issues tracker](http://github.com/astrails/safe/issues)
+
+## Usage
+
+    Usage:
+       astrails-safe [OPTIONS] CONFIG_FILE
+    Options:
+      -h, --help           This help screen
+      -v, --verbose        be verbose, duh!
+      -n, --dry-run        just pretend, don't do anything.
+      -L, --local          skip remote storage, only do local backups
+
+Note: CONFIG\_FILE will be created from template if missing
+
+## Encryption
+
+If you want to encrypt your backups you have 2 options:
+* use simple password encryption
+* use GPG public key encryption
+
+> IMPORTANT: some gpg installations automatically set 'use-agent' option in the default
+> configuration file that is created when you run gpg for the first time. This will cause
+> gpg to fail on the 2nd run if you don't have the agent running. The result is that
+> 'astrails-safe' will work ONCE when you manually test it and then fail on any subsequent run.
+> The solution is to remove the 'use-agent' from the config file (usually /root/.gnupg/gpg.conf)
+> To mitigate this problem for the gpg 1.x series '--no-use-agent' option is added by defaults
+> to the autogenerated config file, but for gpg2 is doesn't work. as the manpage says it:
+> "This is dummy option. gpg2 always requires the agent." :(
+
+For simple password, just add password entry in gpg section.
+For public key encryption you will need to create a public/secret keypair.
+
+We recommend to create your GPG keys only on your local machine and then
+transfer your public key to the server that will do the backups.
+
+This way the server will only know how to encrypt the backups but only you
+will be able to decrypt them using the secret key you have locally. Of course
+you MUST backup your backup encryption key :)
+We recommend also pringing the hard paper copy of your GPG key 'just in case'.
+
+The procedure to create and transfer the key is as follows:
+
+1. run 'gpg --gen-key' on your local machine and follow onscreen instructions to create the key
+   (you can accept all the defaults).
+
+2. extract your public key into a file (assuming you used test@example.com as your key email):
+   `gpg -a --export test@example.com > test@example.com.pub`
+
+3. transfer public key to the server
+   `scp test@example.com.pub root@example.com:`
+
+4. import public key on the remote system:
+
+    $ gpg --import test@example.com.pub
+    gpg: key 45CA9403: public key "Test Backup <test@example.com>" imported
+    gpg: Total number processed: 1
+    gpg:               imported: 1
+
+5. since we don't keep the secret part of the key on the remote server, gpg has
+   no way to know its yours and can be trusted.
+   To fix that we can sign it with other trusted key, or just directly modify its
+   trust level in gpg (use level 5):
+
+     $ gpg --edit-key test@example.com
+     ...
+     Command> trust
+     ...
+     1 = I don't know or won't say
+     2 = I do NOT trust
+     3 = I trust marginally
+     4 = I trust fully
+     5 = I trust ultimately
+     m = back to the main menu
+
+     Your decision? 5
+     ...
+     Command> quit
+
+6. export your secret key for backup
+   (we recommend to print it on paper and burn to a CD/DVD and store in a safe place):
+
+    $ gpg -a --export-secret-key test@example.com > test@example.com.key
+
+
+
+## Example configuration
+
+    safe do
+      verbose true
+
+      local :path => "/backup/:kind/:id"
+
+      s3 do
+        key "...................."
+        secret "........................................"
+        bucket "backup.astrails.com"
+        path "servers/alpha/:kind/:id"
+      end
+
+      cloudfiles do
+        user "..........."
+        api_key "................................."
+        container "safe_backup"
+        path ":kind/" # this is default
+        service_net false
+      end
+
+      sftp do
+        host "sftp.astrails.com"
+        user "astrails"
+        # port 8023
+        password "ssh password for sftp"
+      end
+
+      ftp do
+        host "YOUR_REMOTE_HOSTNAME"
+        user "YOUR_REMOTE_USERNAME"
+        # port "NON STANDARD FTP PORT"
+        password "YOUR_REMOTE_PASSWORD"
+        path ":kind/:id" # this is the default
+      end
+
+      gpg do
+        command "/usr/local/bin/gpg"
+        options  "--no-use-agent"
+        # symmetric encryption key
+        # password "qwe"
+
+        # public GPG key (must be known to GPG, i.e. be on the keyring)
+        key "backup@astrails.com"
+      end
+
+      keep do
+        local 20
+        s3 100
+        cloudfiles 100
+        sftp 100
+      end
+
+      mysqldump do
+        options "-ceKq --single-transaction --create-options"
+
+        user "root"
+        password "............"
+        socket "/var/run/mysqld/mysqld.sock"
+
+        database :blog
+        database :servershape
+        database :astrails_com
+        database :secret_project_com do
+          skip_tables "foo"
+          skip_tables ["bar", "baz"]
+        end
+
+      end
+
+      svndump do
+        repo :my_repo do
+          repo_path "/home/svn/my_repo"
+        end
+      end
+
+      pgdump do
+        options "-i -x -O"   # -i => ignore version, -x => do not dump privileges (grant/revoke), -O => skip restoration of object ownership in plain text format
+
+        user "username"
+        password "............"  # shouldn't be used, instead setup ident.  Current functionality exports a password env to the shell which pg_dump uses - untested!
+
+        database :blog
+        database :stateofflux_com
+      end
+
+      tar do
+        options "-h" # dereference symlinks
+        archive "git-repositories", :files => "/home/git/repositories"
+        archive "dot-configs",      :files => "/home/*/.[^.]*"
+        archive "etc",              :files => "/etc", :exclude => "/etc/puppet/other"
+
+        archive "blog-astrails-com" do
+          files "/var/www/blog.astrails.com/"
+          exclude "/var/www/blog.astrails.com/log"
+          exclude "/var/www/blog.astrails.com/tmp"
+        end
+
+        archive "astrails-com" do
+          files "/var/www/astrails.com/"
+          exclude ["/var/www/astrails.com/log", "/var/www/astrails.com/tmp"]
+        end
+      end
+    end
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2010-2013 Astrails Ltd. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+
+desc "run specs"
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/TODO

@@ -0,0 +1,31 @@
+- refactor
+  - refactor out global variables. pass a config object around instead
+  - common logging
+  - remove 1.8.6 support
+  - module registry
+  - base => prefix ?
+  - move requires into specific modules
+	- config.foo instead of config[:foo]
+
+- features
+  - remote-only s3 support
+  - generic notifier support
+    - email notifier
+    - hipchat
+  - generic error notifier support
+    - email
+    - hipchat
+
+
+
+- add 'silent'
+- handle errors from mysqldump
+- check that gpg is installed
+- support percona XtraBackup as an option instead of mysqldump [patches anyone :) ?]
+- backup validation:
+  - support for 'minsize' opition in backup that will check that produced backup is at least the expected size
+    this should catch many backup failure scenarious (like broken mysql connection, insufficient disk space etc.
+- support differencial backups
+  - it should be fairly easy for filesystem backups using tar's built in incremental functionality.
+  - for mysql need to use XtraBackup
+  - or we can keep the previous dump locally and store only diff with the latest dump

data/akupchanko-astrails-safe.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'astrails/safe/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "akupchanko-astrails-safe"
+  spec.version       = Astrails::Safe::VERSION
+  spec.authors       = ["Vitaly Kushner"]
+  spec.email         = ["we@astrails.com"]
+  spec.description = <<-DESC
+Astrails-Safe is a simple tool to backup databases (MySQL and PostgreSQL), Subversion repositories (with svndump) and just files.
+Backups can be stored locally or remotely and can be enctypted.
+Remote storage is supported on Amazon S3, Rackspace Cloud Files, or just plain FTP/SFTP.
+DESC
+  spec.summary       = %Q{Backup filesystem and databases (MySQL and PostgreSQL) locally or to a remote server/service (with encryption)}
+  spec.homepage      = "http://astrails.com/blog/astrails-safe"
+  spec.license       = "MIT"
+
+  spec.default_executable = %q{astrails-safe}
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-s3"
+  spec.add_dependency "cloudfiles"
+  spec.add_dependency "net-sftp"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rr", "~> 1.0.4"
+end

data/bin/astrails-safe

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+require 'astrails/safe'
+
+include Astrails::Safe
+
+def die(msg)
+  puts "ERROR: #{msg}"
+  exit 1
+end
+
+def usage
+  puts <<-END
+Usage: astrails-safe [OPTIONS] CONFIG_FILE
+Options:
+  -h, --help           This help screen
+  -v, --verbose        be verbose, duh!
+  -n, --dry-run        just pretend, don't do anything.
+  -L, --local          skip S3 and Cloud Files
+
+Note: config file will be created from template if missing
+END
+  exit 1
+end
+
+OPTS = [
+  '-h', '--help',
+  '-v', '--verbose', '--not-verbose',
+  '-n', '--dry-run', '--not-dry-run',
+  '-L', '--local', '--not-local'
+]
+def main
+  opts = ARGV & OPTS
+  args = ARGV - OPTS
+
+  usage unless args.first
+  usage if opts.delete("-h") || opts.delete("--help")
+
+  config_file = File.expand_path(args.first)
+
+  is_dry = (opts.delete('-n') || opts.delete('--dry-run')) && ! opts.delete('--not-dry-run')
+  is_verbose = (opts.delete('-v') || opts.delete('--verbose')) && !opts.delete('--not-verbose')
+  is_local_only = (opts.delete('-L') || opts.delete('--local')) && !opts.delete('--not-local')
+
+  unless File.exists?(config_file)
+    die "Missing configuration file. NOT CREATED! Rerun w/o the -n argument to create a template configuration file." if is_dry
+
+    FileUtils.cp File.join(Astrails::Safe::ROOT, "templates", "script.rb"), config_file
+
+    die "Created default #{config_file}. Please edit and run again."
+  end
+
+  config = eval(File.read(config_file))
+
+  config[:verbose]    = is_verbose
+  config[:dry_run]    = is_dry
+  config[:local_only] = is_local_only
+
+  process config
+end
+
+main