astrails-safe 0.1.1 → 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Astrails Ltd.
+
+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.rdoc

@@ -0,0 +1,132 @@
+= astrails-safe
+
+Simple mysql and filesystem backups with S3 support (with optional encryption)
+
+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
+
+Note: CONFIG_FILE will be created from template if missing
+
+If you want to encrypt your backups you have 2 options:
+* use simple password encryption
+* use GPG public key encryption
+
+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-gen' 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 backup@example.com 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
+  local :path => "/backup/:kind/:id"
+
+  s3 do
+    key "...................."
+    secret "........................................"
+    bucket "backup.astrails.com"
+    path "servers/alpha/:kind/:id"
+  end
+
+  gpg do
+	# 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 2
+    s3 2
+  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
+
+  end
+
+
+  tar do
+    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", "/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
+
+== Copyright
+
+Copyright (c) 2009 Astrails Ltd. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "safe"
+    gem.summary = %Q{Backup filesystem and MySQL to Amazon S3 (with encryption)}
+    gem.description = "Simple tool to backup MySQL databases and filesystem locally or to Amazon S3 (with optional encryption)"
+    gem.email = "we@astrails.com"
+    gem.homepage = "http://github.com/astrails/safe"
+    gem.authors  = ["Astrails Ltd."]
+
+    gem.add_dependency("aws-s3")
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "safe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 2
+:major: 0
+:minor: 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: astrails-safe
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Astrails Ltd.
@@ -9,8 +9,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-15 00:00:00 -07:00
-default_executable: 
+date: 2009-04-06 00:00:00 -07:00
+default_executable: astrails-safe
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aws-s3
@@ -28,33 +28,35 @@ executables:
 - astrails-safe
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
 files: 
-- README
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
 - bin/astrails-safe
-- lib/extensions/mktmpdir.rb
 - lib/astrails/safe.rb
-- lib/astrails/safe/s3.rb
-- lib/astrails/safe/gpg.rb
-- lib/astrails/safe/mysqldump.rb
-- lib/astrails/safe/stream.rb
+- lib/astrails/safe/archive.rb
 - lib/astrails/safe/config/builder.rb
 - lib/astrails/safe/config/node.rb
-- lib/astrails/safe/sink.rb
+- lib/astrails/safe/gpg.rb
+- lib/astrails/safe/gzip.rb
+- lib/astrails/safe/local.rb
+- lib/astrails/safe/mysqldump.rb
 - lib/astrails/safe/pipe.rb
+- lib/astrails/safe/s3.rb
+- lib/astrails/safe/sink.rb
 - lib/astrails/safe/source.rb
-- lib/astrails/safe/archive.rb
-- lib/astrails/safe/local.rb
+- lib/astrails/safe/stream.rb
 - lib/astrails/safe/tmp_file.rb
-- lib/astrails/safe/gzip.rb
-- templates/script.rb
-- safe.gemspec
-has_rdoc: false
+- lib/extensions/mktmpdir.rb
+has_rdoc: true
 homepage: http://github.com/astrails/safe
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -75,6 +77,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Astrails Safe
+summary: Backup filesystem and MySQL to Amazon S3 (with encryption)
 test_files: []
 

data/README

@@ -1,13 +0,0 @@
-Simple mysql and filesystem backups with S3 support
-
-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
-
-Note: CONFIG_FILE will be created from template if missing
-
-See template for configuration examples

data/safe.gemspec

@@ -1,37 +0,0 @@
-Gem::Specification.new do |s|
-  s.name     = "safe"
-  s.version  = "0.1.1"
-  s.date     = "2009-03-15"
-  s.summary  = "Astrails Safe"
-  s.email    = "we@astrails.com"
-  s.homepage = "http://github.com/astrails/safe"
-  s.description = "Simple tool to backup MySQL databases and filesystem locally or to Amazon S3 (with optional encryption)"
-  s.has_rdoc = false
-  s.authors  = ["Astrails Ltd."]
-  s.files    = files = %w(
-  README
-  bin/astrails-safe
-  lib/extensions/mktmpdir.rb
-  lib/astrails/safe.rb
-  lib/astrails/safe/s3.rb
-  lib/astrails/safe/gpg.rb
-  lib/astrails/safe/mysqldump.rb
-  lib/astrails/safe/stream.rb
-  lib/astrails/safe/config/builder.rb
-  lib/astrails/safe/config/node.rb
-  lib/astrails/safe/sink.rb
-  lib/astrails/safe/pipe.rb
-  lib/astrails/safe/source.rb
-  lib/astrails/safe/archive.rb
-  lib/astrails/safe/local.rb
-  lib/astrails/safe/tmp_file.rb
-  lib/astrails/safe/gzip.rb
-  templates/script.rb
-  safe.gemspec
-  )
-  s.executables = files.grep(/^bin/).map {|x| x.gsub(/^bin\//, "")}
-
-  s.test_files = []
-  s.add_dependency("aws-s3")
-end
-

data/templates/script.rb

@@ -1,109 +0,0 @@
-safe do
-
-  # backup file path (not including filename)
-  # supported substitutions:
-  #   :kind -> backup 'engine' kind, e.g. "mysqldump" or "archive"
-  #   :id -> backup 'id', e.g. "blog", "production", etc.
-  #   :timestamp -> current run timestamp (same for all the backups in the same 'run')
-  # you can set separate :path for all backups (or once globally here)
-  local do
-    path "/backup/:kind/"
-  end
-
-  ## uncomment to enable uploads to Amazon S3
-  ## Amazon S3 auth (optional)
-  ## don't forget to add :s3 to the 'store' list
-  # s3 do
-  #   key YOUR_S3_KEY
-  #   secret YOUR_S3_SECRET
-  #   bucket S3_BUCKET
-  #   # path for uploads to S3. supports same substitution like :local/:path
-  #   path ":kind/" # this is default
-  # end
-
-  ## alternative style:
-  # s3 :key => YOUR_S3_KEY, :secret => YOUR_S3_SECRET, :bucket => S3_BUCKET
-
-  ## uncomment to enable GPG encryption.
-  ## Note: you can use public 'key' or symmetric password but not both!
-  # gpg do
-  #   # key "backup@astrails.com"
-  #   password "astrails"
-  # end
-
-  ## uncomment to enable backup rotation. keep only given number of latest
-  ## backups. remove the rest
-  # keep do
-  #   local 4 # keep 4 local backups
-  #   s3 20 # keep 20 S3 backups
-  # end
-
-  # backup mysql databases with mysqldump
-  mysqldump do
-    # you can override any setting from parent in a child:
-    options "-ceKq --single-transaction --create-options"
-
-    user "astrails"
-    password ""
-    # host "localhost"
-    # port 3306
-    socket "/var/run/mysqld/mysqld.sock"
-
-    # database is a 'collection' element. it must have a hash or block parameter
-    # it will be 'collected' in a 'databases', with database id (1st arg) used as hash key
-    # the following code will create mysqldump/databases/blog and mysqldump/databases/mysql ocnfiguration 'nodes'
-
-    # backup database with default values
-    # database :blog
-
-    # backup overriding some values
-    # database :production do
-    #   # you can override 'partially'
-    #   keep :local => 3
-    #   # keep/local is 3, and keep/s3 is 20 (from parent)
-
-    #   # local override for gpg password
-    #   gpg do
-    #     password "custom-production-pass"
-    #   end
-
-    #   skip_tables [:logger_exceptions, :request_logs] # skip those tables during backup
-    # end
-
-  end
-
-
-  tar do
-    # 'archive' is a collection item, just like 'database'
-    # archive "git-repositories" do
-    #   # files and directories to backup
-    #   files "/home/git/repositories"
-    # end
-
-    # archive "etc-files" do
-    #   files "/etc"
-    #   # exlude those files/directories
-    #   exclude "/etc/puppet/other"
-    # end
-
-    # archive "dot-configs" do
-    #   files "/home/*/.[^.]*"
-    # end
-
-    # archive "blog" do
-    #   files "/var/www/blog.astrails.com/"
-    #   # specify multiple files/directories as array
-    #   exclude ["/var/www/blog.astrails.com/log", "/var/www/blog.astrails.com/tmp"]
-    # end
-
-    # archive "site" do
-    #   files "/var/www/astrails.com/"
-    #   exclude ["/var/www/astrails.com/log", "/var/www/astrails.com/tmp"]
-    # end
-
-    # archive :misc do
-    #   files [ "/backup/*.rb" ]
-    # end
-  end
-
-end