backup 3.10.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d08ea59b9238db092857f8ee08a10f1c695d1705
-  data.tar.gz: 8030b371b0b43a7ba075927af576265d5ddf8969
+  metadata.gz: 90a0ce4d50fcbf5dbc1ff35c6ceb182757b5b1ca
+  data.tar.gz: e6cd5b21bed38cd91d97dad2489d38107e33a387
 SHA512:
-  metadata.gz: 8f76e9862b4784775aecd53127ebe9c478f378a7162348d88bd2fd5e0b515b144deb89dd89c68d7b4592f0f8d94eda4ac228bee29f204a240ab635038089ed27
-  data.tar.gz: 13c73bfd31689f46c9f0c809849e59180a1e4eebeb0af05650dae7a8948895f2dc5e80e08c6a67c16a5028fb6b58269be05f49f56d8fc3a7b6782730890a1e3c
+  metadata.gz: dfec691ea4ad54ed847451247fbc26d8f476360075becea60416249a22805740284c18c5d5e6e16333dfa344402dd607feaf0d9b147b1763ff3ad580051d165c
+  data.tar.gz: d0b6389c651ef00d14833b03830864b90e1c71cdae7dbc17bb6f308d58c4b03c68c716e32c58048a24e442a1ddfcd9087ec801a2b827a9632bdeb18af6965d75

data/README.md

@@ -1,235 +1,19 @@
-Backup
-======
+Backup v3.x
+===========
 
 Backup is a system utility for Linux and Mac OS X, distributed as a RubyGem, that allows you to easily perform backup
 operations. It provides an elegant DSL in Ruby for _modeling_ your backups. Backup has built-in support for various
 databases, storage protocols/services, syncers, compressors, encryptors and notifiers which you can mix and match. It
 was built with modularity, extensibility and simplicity in mind.
 
-## Installation
+[Installation][] · [Release Notes][] · [Documentation][]
 
-**_Do not add `gem backup` to an application's `Gemfile`_**
 
-To install the latest version, run:
-
-    $ [sudo] gem install backup
-
-See [Installation](https://github.com/meskyanichi/backup/wiki/Installation) for more information about installing and
-updating your installation of Backup.
-
-See [Release Notes](https://github.com/meskyanichi/backup/wiki/Release-Notes) for changes in the latest version.
-
-Backup supports Ruby versions 1.8.7, 1.9.2, 1.9.3 and 2.0.0.
-
-## Overview
-
-Backup allows you to _model_ your backup jobs using a Ruby DSL:
-
-```rb
-Backup::Model.new(:my_backup, 'Description for my_backup') do
-  # ... components here ...
-end
-```
-
-The `:my_backup` symbol is the model's `trigger` and used to perform the job:
-
-    $ backup perform --trigger my_backup
-
-Backup's _components_ are added to the backup _model_ to define the actions to be performed.  
-All of Backup's components are fully documented in the [Backup Wiki](https://github.com/meskyanichi/backup/wiki).  
-The following is brief overview of the components Backup provides:
-
-### Archives and Databases
-
-[Archives](https://github.com/meskyanichi/backup/wiki/Archives) create basic `tar` archives. Both **GNU** and **BSD**
-`tar` are supported.  
-[Databases](https://github.com/meskyanichi/backup/wiki/Databases) create backups of one of the following supported databases:
-
-- MySQL
-- PostgreSQL
-- MongoDB
-- Redis
-- Riak
-
-Any number of Archives and Databases may be defined within a backup _model_.
-
-### Compressors and Encryptors
-
-Adding a [Compressor](https://github.com/meskyanichi/backup/wiki/Compressors) to your backup will compress all the
-Archives and Database backups within your final archive package.  
-`Gzip`, `Bzip2` and other similar compressors are supported.
-
-Adding a [Encryptor](https://github.com/meskyanichi/backup/wiki/Encryptors) allows you to encrypt your final backup package.  
-Both `OpenSSL` and `GPG` are supported.
-
-Your final backup _package_ might look something like this:
-
-```text
-$ gpg --decrypt my_backup.tar.gpg --outfile my_backup.tar
-$ tar -tvf my_backup.tar
-  my_backup/
-  my_backup/archives/
-  my_backup/archives/user_avatars.tar.gz
-  my_backup/archives/log_files.tar.gz
-  my_backup/databases/
-  my_backup/databases/PostgreSQL.sql.gz
-  my_backup/databases/Redis.rdb.gz
-```
-
-### Storages
-
-Once your final backup package is ready, you can use any number of the following
-[Storages](https://github.com/meskyanichi/backup/wiki/Storages) to store it:
-
-- Amazon Simple Storage Service (S3)
-- Rackspace Cloud Files (Mosso)
-- Ninefold Cloud Storage
-- Dropbox Web Service
-- Remote Servers _(Available Protocols: FTP, SFTP, SCP and RSync)_
-- Local Storage _(including network mounted locations)_
-
-All of the above Storages _(except RSync)_ support:
-
-- [Cycling](https://github.com/meskyanichi/backup/wiki/Cycling) to keep and rotate multiple copies
-of your stored backups.
-
-- [Splitter](https://github.com/meskyanichi/backup/wiki/Splitter) to break up a large
-backup package into smaller files.
-
-When using the RSync Storage, once a full backup has been stored, subsequent backups only need to
-transmit the changed portions of the final archive to bring the remote copy up-to-date.
-
-### Syncers
-
-[Syncers](https://github.com/meskyanichi/backup/wiki/Syncers) are processed after your final backup archive has been
-stored and allow you to perform file synchronization.
-
-Backup includes two types of Syncers:
-
-- `RSync`: Used to sync files locally, local-to-remote (`Push`), or remote-to-local (`Pull`).  
-- `Cloud`: Used to sync files to remote storage services like Amazon S3 and Rackspace.
-
-A backup _model_ may contain _only_ Syncers as well.
-
-### Notifiers
-
-[Notifiers](https://github.com/meskyanichi/backup/wiki/Notifiers) are used to send notifications upon successful and/or
-failed completion of your backup _model_.
-
-Supported notification services include:
-
-- Email _(SMTP, Sendmail, Exim and File delivery)_
-- Twitter
-- Campfire
-- Presently
-- Prowl
-- Hipchat
-- Pushover
-- POST Request
-- Nagios
-
-
-## Generators
-
-Backup makes it easy to setup new backup _model_ files with it's [Generator](https://github.com/meskyanichi/backup/wiki/Generator) command.  
-
-```
-$ backup generate:model -t my_backup --archives --databases=postgresql,redis --compressors=gzip \
-    --encryptors=gpg --storages=sftp,s3 --notifiers=mail,twitter
-```
-
-Simply generate a new _model_ using the options you need, then update the configuration for each component using the
-[Wiki](https://github.com/meskyanichi/backup/wiki) documentation.
-
-The following is an example of a what this Backup _model_ might look like:
-
-```rb
-Backup::Model.new(:my_backup, 'Description for my_backup') do
-  split_into_chunks_of 250
-
-  archive :user_avatars do |archive|
-    archive.add '/var/apps/my_sample_app/public/avatars'
-  end
-
-  archive :log_files do |archive|
-    archive.add     '/var/apps/my_sample_app/logs'
-    archive.exclude '/var/apps/my_sample_app/logs/exclude-this.log'
-  end
-
-  database PostgreSQL do |db|
-    db.name               = "pg_db_name"
-    db.username           = "username"
-    db.password           = "password"
-  end
-
-  database Redis do |db|
-    db.name               = "redis_db_name"
-    db.path               = "/usr/local/var/db/redis"
-    db.password           = "password"
-    db.invoke_save        = true
-  end
-
-  compress_with Gzip
-
-  encrypt_with GPG do |encryption|
-    encryption.mode = :symmetric
-    encryption.passphrase = 'my_password'
-  end
-
-  store_with SFTP do |server|
-    server.username   = "my_username"
-    server.password   = "my_password"
-    server.ip         = "123.45.678.90"
-    server.port       = 22
-    server.path       = "~/backups/"
-    server.keep       = 5
-  end
-
-  store_with S3 do |s3|
-    s3.access_key_id     = "my_access_key_id"
-    s3.secret_access_key = "my_secret_access_key"
-    s3.region            = "us-east-1"
-    s3.bucket            = "bucket-name"
-    s3.path              = "/path/to/my/backups"
-    s3.keep              = 10
-  end
-
-  notify_by Mail do |mail|
-    mail.on_success           = false
-
-    mail.from                 = "sender@email.com"
-    mail.to                   = "receiver@email.com"
-    mail.address              = "smtp.gmail.com"
-    mail.port                 = 587
-    mail.user_name            = "sender@email.com"
-    mail.password             = "my_password"
-    mail.authentication       = "plain"
-    mail.encryption           = :starttls
-  end
-
-  notify_by Twitter do |tweet|
-    tweet.consumer_key       = "my_consumer_key"
-    tweet.consumer_secret    = "my_consumer_secret"
-    tweet.oauth_token        = "my_oauth_token"
-    tweet.oauth_token_secret = "my_oauth_token_secret"
-  end
-end
-```
-
-The [Getting Started](https://github.com/meskyanichi/backup/wiki/Getting-Started) page provides a simple
-walk-through to familiarize you with setting up, configuring and running a backup job.
-
-## Suggestions, Issues, etc...
-
-If you have any suggestions or problems, please submit an Issue or Pull Request using Backup's
-[Issue Log](https://github.com/meskyanichi/backup/issues).
-
-If you find any errors or omissions in Backup's documentation [Wiki](https://github.com/meskyanichi/backup/wiki),
-please feel free to edit it!
-
-Backup has seen many improvements over the years thanks to it's
-[Contributors](https://github.com/meskyanichi/backup/contributors), as well as those who have help discuss issues and
-improve the documentation, and looks forward to continuing to provide users with a reliable backup solution.
-
-**Copyright (c) 2009-2013 [Michael van Rooijen](http://michaelvanrooijen.com/) ( [@meskyanichi](http://twitter.com/#!/meskyanichi) )**  
+**Copyright (c) 2009-2014 [Michael van Rooijen][] ( [@meskyanichi][] )**  
 Released under the **MIT** [License](LICENSE.md).
+
+[Installation]:  http://meskyanichi.github.io/backup/v3/installation
+[Release Notes]: http://meskyanichi.github.io/backup/v3/release-notes
+[Documentation]: http://meskyanichi.github.io/backup/v3
+[Michael van Rooijen]: http://michaelvanrooijen.com
+[@meskyanichi]: http://twitter.com/#!/meskyanichi

data/lib/backup/database/mysql.rb

@@ -32,28 +32,48 @@ module Backup
       attr_accessor :only_tables
 
       ##
-      # Additional "mysqldump" options
+      # Additional "mysqldump" or "innobackupex (backup creation)" options
       attr_accessor :additional_options
 
+      ##
+      # Additional innobackupex log preparation phase ("apply-logs") options
+      attr_accessor :prepare_options
+
+      ##
+      # Default is :mysqldump (which is built in MySQL and generates
+      # a textual SQL file), but can be changed to :innobackupex, which
+      # has more feasible restore times for large databases.
+      # See: http://www.percona.com/doc/percona-xtrabackup/
+      attr_accessor :backup_engine
+
+      ##
+      # If set the backup engine command block is executed as the given user
+      attr_accessor :sudo_user
+
+      ##
+      # If set, do not suppress innobackupdb output (useful for debugging)
+      attr_accessor :verbose
+
       def initialize(model, database_id = nil, &block)
         super
         instance_eval(&block) if block_given?
 
         @name ||= :all
+        @backup_engine ||= :mysqldump
       end
 
       ##
-      # Performs the mysqldump command and outputs the dump file
-      # in the +dump_path+ using +dump_filename+.
+      # Performs the mysqldump or innobackupex command and outputs
+      # the dump file in the +dump_path+ using +dump_filename+.
       #
-      #   <trigger>/databases/MySQL[-<database_id>].sql[.gz]
+      #   <trigger>/databases/MySQL[-<database_id>].[sql|tar][.gz]
       def perform!
         super
 
         pipeline = Pipeline.new
-        dump_ext = 'sql'
+        dump_ext = sql_backup? ? 'sql' : 'tar'
 
-        pipeline << mysqldump
+        pipeline << sudo_option(sql_backup? ? mysqldump : innobackupex)
 
         model.compressor.compress_with do |command, ext|
           pipeline << command
@@ -99,6 +119,10 @@ module Backup
         Array(additional_options).join(' ')
       end
 
+      def user_prepare_options
+        Array(prepare_options).join(' ')
+      end
+
       def name_option
         dump_all? ? '--all-databases' : name
       end
@@ -130,6 +154,39 @@ module Backup
             Utilities.configure { mysqldump val }
           }
 
+      def sql_backup?
+        backup_engine.to_sym == :mysqldump
+      end
+
+      def innobackupex
+        # Creation phase
+        "#{ utility(:innobackupex) } #{ credential_options } " +
+        "#{ connectivity_options } #{ user_options } " +
+        "--no-timestamp #{ temp_dir } #{ quiet_option } && " +
+        # Log applying phase (prepare for restore)
+        "#{ utility(:innobackupex) } --apply-log #{ temp_dir } " +
+        "#{ user_prepare_options }  #{ quiet_option } && " +
+        # Move files to tar-ed stream on stdout
+        "#{ utility(:tar) } --remove-files -cf -  " +
+        "-C #{ File.dirname(temp_dir) } #{ File.basename(temp_dir) }"
+      end
+
+      def sudo_option(command_block)
+        return command_block unless sudo_user
+
+        "sudo -s -u #{ sudo_user } -- <<END_OF_SUDO\n" +
+        "#{command_block}\n" +
+        "END_OF_SUDO\n"
+      end
+
+      def quiet_option
+        verbose ? "" : " 2> /dev/null "
+      end
+
+      def temp_dir
+        File.join(dump_path, dump_filename + ".bkpdir")
+      end
+
     end
   end
 end

data/lib/backup/utilities.rb

@@ -8,7 +8,8 @@ module Backup
     NAMES = %w{
       tar cat split sudo chown hostname
       gzip bzip2 lzma pbzip2
-      mongo mongodump mysqldump pg_dump pg_dumpall redis-cli riak-admin
+      mongo mongodump mysqldump innobackupex
+      pg_dump pg_dumpall redis-cli riak-admin
       gpg openssl
       rsync ssh
       sendmail exim

data/lib/backup/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Backup
-  VERSION = '3.10.0'
+  VERSION = '3.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: backup
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.11.0
 platform: ruby
 authors:
 - Michael van Rooijen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-20 00:00:00.000000000 Z
+date: 2014-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -501,17 +501,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Provides an elegant DSL in Ruby for performing backups on UNIX-like systems.