backupii 0.1.0.pre.alpha.1

data/templates/cli/config

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+##
+# Backup v<%= Backup::VERSION.split('.').first %>.x Configuration
+#
+# Documentation: http://backup.github.io/backup
+# Issue Tracker: https://github.com/backup/backup/issues
+
+##
+# Config Options
+#
+# The options here may be overridden on the command line, but the result
+# will depend on the use of --root-path on the command line.
+#
+# If --root-path is used on the command line, then all paths set here
+# will be overridden. If a path (like --tmp-path) is not given along with
+# --root-path, that path will use it's default location _relative to --root-path_.
+#
+# If --root-path is not used on the command line, a path option (like --tmp-path)
+# given on the command line will override the tmp_path set here, but all other
+# paths set here will be used.
+#
+# Note that relative paths given on the command line without --root-path
+# are relative to the current directory. The root_path set here only applies
+# to relative paths set here.
+#
+# ---
+#
+# Sets the root path for all relative paths, including default paths.
+# May be an absolute path, or relative to the current working directory.
+#
+# root_path 'my/root'
+#
+# Sets the path where backups are processed until they're stored.
+# This must have enough free space to hold apx. 2 backups.
+# May be an absolute path, or relative to the current directory or +root_path+.
+#
+# tmp_path  'my/tmp'
+#
+# Sets the path where backup stores persistent information.
+# When Backup's Cycler is used, small YAML files are stored here.
+# May be an absolute path, or relative to the current directory or +root_path+.
+#
+# data_path 'my/data'
+
+##
+# Utilities
+#
+# If you need to use a utility other than the one Backup detects,
+# or a utility can not be found in your $PATH.
+#
+#   Utilities.configure do
+#     tar       '/usr/bin/gnutar'
+#     redis_cli '/opt/redis/redis-cli'
+#   end
+
+##
+# Logging
+#
+# Logging options may be set on the command line, but certain settings
+# may only be configured here.
+#
+#   Logger.configure do
+#     console.quiet     = true            # Same as command line: --quiet
+#     logfile.max_bytes = 2_000_000       # Default: 500_000
+#     syslog.enabled    = true            # Same as command line: --syslog
+#     syslog.ident      = 'my_app_backup' # Default: 'backup'
+#   end
+#
+# Command line options will override those set here.
+# For example, the following would override the example settings above
+# to disable syslog and enable console output.
+#   backup perform --trigger my_backup --no-syslog --no-quiet
+
+##
+# Component Defaults
+#
+# Set default options to be applied to components in all models.
+# Options set within a model will override those set here.
+#
+#   Storage::S3.defaults do |s3|
+#     s3.access_key_id     = "my_access_key_id"
+#     s3.secret_access_key = "my_secret_access_key"
+#   end
+#
+#   Notifier::Mail.defaults do |mail|
+#     mail.from                 = 'sender@email.com'
+#     mail.to                   = 'receiver@email.com'
+#     mail.address              = 'smtp.gmail.com'
+#     mail.port                 = 587
+#     mail.domain               = 'your.host.name'
+#     mail.user_name            = 'sender@email.com'
+#     mail.password             = 'my_password'
+#     mail.authentication       = 'plain'
+#     mail.encryption           = :starttls
+#   end
+
+##
+# Preconfigured Models
+#
+# Create custom models with preconfigured components.
+# Components added within the model definition will
+# +add to+ the preconfigured components.
+#
+#   preconfigure 'MyModel' do
+#     archive :user_pictures do |archive|
+#       archive.add '~/pictures'
+#     end
+#
+#     notify_by Mail do |mail|
+#       mail.to = 'admin@email.com'
+#     end
+#   end
+#
+#   MyModel.new(:john_smith, 'John Smith Backup') do
+#     archive :user_music do |archive|
+#       archive.add '~/music'
+#     end
+#
+#     notify_by Mail do |mail|
+#       mail.to = 'john.smith@email.com'
+#     end
+#   end

data/templates/cli/databases/mongodb

@@ -0,0 +1,15 @@
+  ##
+  # MongoDB [Database]
+  #
+  database MongoDB do |db|
+    db.name               = "my_database_name"
+    db.username           = "my_username"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 27017
+    db.ipv6               = false
+    db.only_collections   = ["only", "these", "collections"]
+    db.additional_options = []
+    db.lock               = false
+    db.oplog              = false
+  end

data/templates/cli/databases/mysql

@@ -0,0 +1,18 @@
+  ##
+  # MySQL [Database]
+  #
+  database MySQL do |db|
+    # To dump all databases, set `db.name = :all` (or leave blank)
+    db.name               = "my_database_name"
+    db.username           = "my_username"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 3306
+    db.socket             = "/tmp/mysql.sock"
+    # Note: when using `skip_tables` with the `db.name = :all` option,
+    # table names should be prefixed with a database name.
+    # e.g. ["db_name.table_to_skip", ...]
+    db.skip_tables        = ["skip", "these", "tables"]
+    db.only_tables        = ["only", "these", "tables"]
+    db.additional_options = ["--quick", "--single-transaction"]
+  end

data/templates/cli/databases/openldap

@@ -0,0 +1,24 @@
+  ##
+  # OpenLDAP [Database]
+  #
+  database OpenLDAP do |db|
+    # Name of the ldap backup
+    db.name = "my_database_name"
+
+    # Additional "slapcat" options
+    # defaults to an empty list of options
+    # db.slapcat_args      = []
+
+    # run slapcat under sudo if needed
+    # defaults to "false"
+    # db.use_sudo = true
+
+    # Stores the location of the slapd.conf,
+    # defaults to "/etc/ldap/slapd.d" confdir
+    # you can use also conf file instead of directory
+    # db.slapcat_conf = /path/to/slapd.conf
+
+    # Optional: Use to set the location of slapcat utility
+    # if it cannot be found by name in your $PATH
+    # db.slapcat_utility = "/opt/local/bin/slapcat"
+  end

data/templates/cli/databases/postgresql

@@ -0,0 +1,16 @@
+  ##
+  # PostgreSQL [Database]
+  #
+  database PostgreSQL do |db|
+    # To dump all databases, set `db.name = :all` (or leave blank)
+    db.name               = "my_database_name"
+    db.username           = "my_username"
+    db.password           = "my_password"
+    db.host               = "localhost"
+    db.port               = 5432
+    db.socket             = "/tmp/pg.sock"
+    # When dumping all databases, `skip_tables` and `only_tables` are ignored.
+    db.skip_tables        = ["skip", "these", "tables"]
+    db.only_tables        = ["only", "these", "tables"]
+    db.additional_options = ["-xc", "-E=utf8"]
+  end

data/templates/cli/databases/redis

@@ -0,0 +1,16 @@
+  ##
+  # Redis [Database]
+  #
+  database Redis do |db|
+    db.mode               = :copy # or :sync
+    # Full path to redis dump file for :copy mode.
+    db.rdb_path           = '/var/lib/redis/dump.rdb'
+    # When :copy mode is used, perform a SAVE before
+    # copying the dump file specified by `rdb_path`.
+    db.invoke_save        = false
+    db.host               = 'localhost'
+    db.port               = 6379
+    db.socket             = '/tmp/redis.sock'
+    db.password           = 'my_password'
+    db.additional_options = []
+  end

data/templates/cli/databases/riak

@@ -0,0 +1,17 @@
+  ##
+  # Riak [Database]
+  #
+  database Riak do |db|
+    ##
+    # The node from which to perform the backup.
+    # default: 'riak@127.0.0.1'
+    db.node = 'riak@hostname'
+    ##
+    # The Erlang cookie/shared secret used to connect to the node.
+    # default: 'riak'
+    db.cookie = 'cookie'
+    ##
+    # The user for the Riak instance.
+    # default: 'riak'
+    db.user = 'riak'
+  end

data/templates/cli/databases/sqlite

@@ -0,0 +1,11 @@
+  ##
+  # SQLite [Database]
+  #
+  database SQLite do |db|
+    # Path to database file
+    db.path               = "/path/to/my/sqlite/db.sqlite"
+
+    # Optional: Use to set the location of this utility
+    #   if it cannot be found by name in your $PATH
+    db.sqlitedump_utility = "/opt/local/bin/sqlite3"
+  end

data/templates/cli/encryptor/gpg

@@ -0,0 +1,27 @@
+  ##
+  # GPG [Encryptor]
+  #
+  # Setting up #keys, as well as #gpg_homedir and #gpg_config,
+  # would be best set in config.rb using Encryptor::GPG.defaults
+  #
+  encrypt_with GPG do |encryption|
+    # Setup public keys for #recipients
+    encryption.keys = {}
+    encryption.keys['user@domain.com'] = <<-KEY
+      -----BEGIN PGP PUBLIC KEY BLOCK-----
+      Version: GnuPG v1.4.11 (Darwin)
+
+          <Your GPG Public Key Here>
+      -----END PGP PUBLIC KEY BLOCK-----
+    KEY
+
+    # Specify mode (:asymmetric, :symmetric or :both)
+    encryption.mode = :both # defaults to :asymmetric
+
+    # Specify recipients from #keys (for :asymmetric encryption)
+    encryption.recipients = ['user@domain.com']
+
+    # Specify passphrase or passphrase_file (for :symmetric encryption)
+    encryption.passphrase = 'a secret'
+    # encryption.passphrase_file = '~/backup_passphrase'
+  end

data/templates/cli/encryptor/openssl

@@ -0,0 +1,9 @@
+  ##
+  # OpenSSL [Encryptor]
+  #
+  encrypt_with OpenSSL do |encryption|
+    encryption.password      = "my_password"            # From String
+    encryption.password_file = "/path/to/password/file" # Or from File
+    encryption.base64        = true
+    encryption.salt          = true
+  end

data/templates/cli/model

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+##
+# Backup Generated: <%= @options[:trigger] %>
+# Once configured, you can run the backup with the following command:
+#
+# $ backup perform -t <%= @options[:trigger] %> [-c <path_to_configuration_file>]
+#
+# For more information about Backup's components, see the documentation at:
+# http://backup.github.io/backup
+#
+Model.new(:<%= @options[:trigger] %>, 'Description for <%= @options[:trigger] %>') do
+<% if @options[:splitter] %>
+<%= Backup::Template.new.result('cli/splitter') %>
+<% end; if @options[:archives] %>
+<%= Backup::Template.new.result('cli/archive') %>
+<% end; %w{ databases storages syncers encryptor compressor notifiers }.each do |item|
+  if @options[item]
+    @options[item].split(',').map(&:strip).uniq.each do |entry|
+      if File.exist?(File.join(Backup::TEMPLATE_PATH, 'cli', item, entry)) %>
+<%= Backup::Template.new.result("cli/#{ item }/#{ entry }") %>
+<%    end
+    end
+  end
+end %>
+end

data/templates/cli/notifier/zabbix

@@ -0,0 +1,15 @@
+##
+# Zabbix [Notifier]
+#
+notify_by Zabbix do |zabbix|
+    zabbix.on_success = true
+    zabbix.on_warning = true
+    zabbix.on_failure = true
+
+    zabbix.zabbix_host  = "zabbix_server_hostname"
+    zabbix.zabbix_port  = 10051
+    zabbix.service_name = "Backup trigger"
+    zabbix.service_host = "zabbix_host"
+    zabbix.item_key     = "backup_status"
+  end
+

data/templates/cli/notifiers/campfire

@@ -0,0 +1,12 @@
+  ##
+  # Campfire [Notifier]
+  #
+  notify_by Campfire do |campfire|
+    campfire.on_success = true
+    campfire.on_warning = true
+    campfire.on_failure = true
+
+    campfire.api_token = "my_api_authentication_token"
+    campfire.subdomain = "my_subdomain"
+    campfire.room_id   = "my_room_id"
+  end

data/templates/cli/notifiers/command

@@ -0,0 +1,32 @@
+  ##
+  # Command [Notifier]
+  #
+  notify_by Command do |cmd|
+    cmd.on_success = true
+    cmd.on_warning = true
+    cmd.on_failure = true
+
+    # Command to execute
+    cmd.command = 'notify-send'
+
+    # Arguments to pass to the command.
+    #
+    # Must be an array of strings or callable objects.
+    #
+    # Callables will be invoked with #call(model, status),
+    # and the return value used as the argument.
+    #
+    # In strings you can use the following placeholders:
+    #
+    # %l - Model label
+    # %t - Model trigger
+    # %s - Status (success/failure/warning)
+    # %v - Status verb (succeeded/failed/succeeded with warnings)
+    #
+    # All placeholders can be used with uppercase letters to capitalize
+    # the value.
+    #
+    # Defaults to ["%L %v"]
+    #
+    # cmd.args = ["Backup %L", "%V"]
+  end

data/templates/cli/notifiers/datadog

@@ -0,0 +1,57 @@
+  ##
+  # DataDog [Notifier]
+  #
+  notify_by DataDog do |datadog|
+    datadog.on_success           = true
+    datadog.on_warning           = true
+    datadog.on_failure           = true
+
+    datadog.api_key              = 'my_api_key'
+
+    ##
+    # Optional
+    #
+    # Override Default Title
+    # Default is: "Backup #{:label}"
+    # datadog.title                = "Backup #{:status}"
+    #
+    # Override Default Text
+    # Default is "Backup Notification for #{:label}"
+    # datadog.text                 = "Backup #{:status} - #{:message}"
+    #
+    # Provide a hostname to associate this backup to
+    # Default is nil
+    # datadog.host                 = 'db.example.com'
+    #
+    # Add Tags to the Event
+    # Default is nil
+    # valid option is an Array
+    # datadog.tags                 = ['backup', 'env:production']
+    #
+    # Override the Alert Type
+    # Default is based on the :status of the backup:
+    # :success => 'success'
+    # :warning => 'warning'
+    # :failure => 'error'
+    # valid options are: 'info', 'success', 'warning', 'error'
+    # datadog.alert_type           = 'info'
+    #
+    # Add a Source Type
+    # Default is nil
+    # see api docs for valid source_type_names
+    # datadog.source_type_name        = 'my apps'
+    #
+    # Override the Priority Level
+    # Default is 'normal'
+    # valid options are: 'normal' or 'low'
+    # datadog.priority             = 'low'
+    #
+    # Override the Event Time (must be a unix Timestamp)
+    # Default is Time.now.to_i
+    # datadog.date_happened        = Time.now.to_i
+    #
+    # Add an Aggregation Key
+    # Default is nil
+    # max length allowed is 100 characters
+    # datadog.aggregation_key      = 'my_aggregation'
+  end

data/templates/cli/notifiers/flowdock

@@ -0,0 +1,16 @@
+  ##
+  # Flowdock [Notifier]
+  #
+  notify_by FlowDock do |flowdock|
+    flowdock.on_success = true
+    flowdock.on_warning = true
+    flowdock.on_failure = true
+
+    flowdock.token          = "token"
+    flowdock.from_name      = 'my_name'
+    flowdock.from_email     = 'email@example.com'
+    flowdock.subject        = 'My Daily Backup'
+    flowdock.source         = 'Backup'
+    flowdock.tags           = ['prod', 'backup']
+    flowdock.link           = 'www.example.com'
+  end

data/templates/cli/notifiers/hipchat

@@ -0,0 +1,16 @@
+  ##
+  # Hipchat [Notifier]
+  #
+  notify_by Hipchat do |hipchat|
+    hipchat.on_success = true
+    hipchat.on_warning = true
+    hipchat.on_failure = true
+
+    hipchat.token          = "token"
+    hipchat.from           = "DB Backup"
+    hipchat.rooms_notified = ["activity"]
+    hipchat.success_color  = "green"
+    hipchat.warning_color  = "yellow"
+    hipchat.failure_color  = "red"
+    hipchat.api_version    = "v1"
+  end

data/templates/cli/notifiers/http_post

@@ -0,0 +1,32 @@
+  ##
+  # HttpPost [Notifier]
+  #
+  notify_by HttpPost do |post|
+    post.on_success = true
+    post.on_warning = true
+    post.on_failure = true
+
+    # URI to post the notification to.
+    # Port may be specified if needed.
+    # If Basic Authentication is required, supply user:pass.
+    post.uri = 'https://user:pass@your.domain.com:8443/path'
+
+    ##
+    # Optional
+    #
+    # Additional headers to send.
+    # post.headers = { 'Authentication' => 'my_auth_info' }
+    #
+    # Additional form params to post.
+    # post.params = { 'auth_token' => 'my_token' }
+    #
+    # Successful response codes. Default: 200
+    # post.success_codes = [200, 201, 204]
+    #
+    # Defaults to true on most systems.
+    # Force with +true+, disable with +false+
+    # post.ssl_verify_peer = false
+    #
+    # Supplied by default. Override with a custom 'cacert.pem' file.
+    # post.ssl_ca_file = '/my/cacert.pem'
+  end

data/templates/cli/notifiers/mail

@@ -0,0 +1,24 @@
+  ##
+  # Mail [Notifier]
+  #
+  # The default delivery method for Mail Notifiers is 'SMTP'.
+  # See the documentation for other delivery options.
+  #
+  notify_by Mail do |mail|
+    mail.on_success           = true
+    mail.on_warning           = true
+    mail.on_failure           = true
+
+    mail.from                 = "sender@email.com"
+    mail.to                   = "receiver@email.com"
+    mail.cc                   = "cc@email.com"
+    mail.bcc                  = "bcc@email.com"
+    mail.reply_to             = "reply_to@email.com"
+    mail.address              = "smtp.gmail.com"
+    mail.port                 = 587
+    mail.domain               = "your.host.name"
+    mail.user_name            = "sender@email.com"
+    mail.password             = "my_password"
+    mail.authentication       = "plain"
+    mail.encryption           = :starttls
+  end

data/templates/cli/notifiers/nagios

@@ -0,0 +1,13 @@
+  ##
+  # Nagios [Notifier]
+  #
+  notify_by Nagios do |nagios|
+    nagios.on_success = true
+    nagios.on_warning = true
+    nagios.on_failure = true
+
+    nagios.nagios_host  = 'nagioshost'
+    nagios.nagios_port  = 5667
+    nagios.service_name = 'My Backup'
+    nagios.service_host = 'backuphost'
+  end

data/templates/cli/notifiers/pagerduty

@@ -0,0 +1,12 @@
+##
+# PagerDuty [Notifier]
+#
+
+notify_by PagerDuty do |pagerduty|
+  pagerduty.on_success = true
+  pagerduty.on_warning = true
+  pagerduty.on_failure = true
+
+  pagerduty.service_key = '0123456789abcdef01234567890abcde'
+  pagerduty.resolve_on_warning = true
+end

data/templates/cli/notifiers/prowl

@@ -0,0 +1,11 @@
+  ##
+  # Prowl [Notifier]
+  #
+  notify_by Prowl do |prowl|
+    prowl.on_success = true
+    prowl.on_warning = true
+    prowl.on_failure = true
+
+    prowl.application	= "my_application"
+    prowl.api_key    	= "my_api_key"
+  end

data/templates/cli/notifiers/pushover

@@ -0,0 +1,11 @@
+  ##
+  # Pushover [Notifier]
+  #
+  notify_by Pushover do |push|
+    push.on_success = true
+    push.on_warning = true
+    push.on_failure = true
+
+    push.user       = "USER_TOKEN"
+    push.token      = "APP_TOKEN"
+  end

data/templates/cli/notifiers/ses

@@ -0,0 +1,15 @@
+  ##
+  # SES [Notifier]
+  #
+  notify_by Ses do |ses|
+    ses.on_success = true
+    ses.on_warning = true
+    ses.on_failure = true
+
+    ses.access_key_id = ''
+    ses.secret_access_key = ''
+    ses.region = 'eu-west-1'
+
+    ses.from = "sender@email.com"
+    ses.to = "receiver@email.com"
+  end

data/templates/cli/notifiers/slack

@@ -0,0 +1,22 @@
+  ##
+  # Slack [Notifier]
+  #
+  notify_by Slack do |slack|
+    slack.on_success = true
+    slack.on_warning = true
+    slack.on_failure = true
+
+    # The incoming webhook url
+    # https://hooks.slack.com/services/xxxxxxxx/xxxxxxxxx/xxxxxxxxxx
+    slack.webhook_url = 'xxxxxxxxxxxxxxxxxxxxxxxx'
+
+
+    ##
+    # Optional
+    #
+    # The channel to which messages will be sent
+    # slack.channel = 'my_channel'
+    #
+    # The username to display along with the notification
+    # slack.username = 'my_username'
+  end

data/templates/cli/notifiers/twitter

@@ -0,0 +1,13 @@
+  ##
+  # Twitter [Notifier]
+  #
+  notify_by Twitter do |tweet|
+    tweet.on_success = true
+    tweet.on_warning = true
+    tweet.on_failure = true
+
+    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

data/templates/cli/splitter

@@ -0,0 +1,7 @@
+  ##
+  # Split [Splitter]
+  #
+  # Split the backup file in to chunks of 250 megabytes
+  # if the backup file size exceeds 250 megabytes
+  #
+  split_into_chunks_of 250

data/templates/cli/storages/cloud_files

@@ -0,0 +1,11 @@
+  ##
+  # Rackspace Cloud Files [Storage]
+  #
+  store_with CloudFiles do |cf|
+    cf.api_key            = 'my_api_key'
+    cf.username           = 'my_username'
+    cf.container          = 'my_container'
+    cf.segments_container = 'my_segments_container' # must be different than `container`
+    cf.segment_size       = 5 # MiB
+    cf.path               = 'path/to/backups' # path within the container
+  end