sliday_backup 0.1

data/lib/sliday_backup/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module SlidayBackup
+  VERSION = '0.1'
+end

data/templates/cli/archive

@@ -0,0 +1,28 @@
+  ##
+  # Archive [Archive]
+  #
+  # Adding a file or directory (including sub-directories):
+  #   archive.add "/path/to/a/file.rb"
+  #   archive.add "/path/to/a/directory/"
+  #
+  # Excluding a file or directory (including sub-directories):
+  #   archive.exclude "/path/to/an/excluded_file.rb"
+  #   archive.exclude "/path/to/an/excluded_directory
+  #
+  # By default, relative paths will be relative to the directory
+  # where `backup perform` is executed, and they will be expanded
+  # to the root of the filesystem when added to the archive.
+  #
+  # If a `root` path is set, relative paths will be relative to the
+  # given `root` path and will not be expanded when added to the archive.
+  #
+  #   archive.root '/path/to/archive/root'
+  #
+  archive :my_archive do |archive|
+    # Run the `tar` command using `sudo`
+    # archive.use_sudo
+    archive.add "/path/to/a/file.rb"
+    archive.add "/path/to/a/folder/"
+    archive.exclude "/path/to/a/excluded_file.rb"
+    archive.exclude "/path/to/a/excluded_folder"
+  end

data/templates/cli/compressor/bzip2

@@ -0,0 +1,4 @@
+  ##
+  # Bzip2 [Compressor]
+  #
+  compress_with Bzip2

data/templates/cli/compressor/custom

@@ -0,0 +1,7 @@
+  ##
+  # Custom [Compressor]
+  #
+  compress_with Custom do |compressor|
+    compressor.command   = 'gzip'
+    compressor.extension = '.gz'
+  end

data/templates/cli/compressor/gzip

@@ -0,0 +1,4 @@
+  ##
+  # Gzip [Compressor]
+  #
+  compress_with Gzip

data/templates/cli/config

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+##
+# SlidayBackup v<%= SlidayBackup::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 SlidayBackup'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 SlidayBackup 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 SlidayBackup') 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
+
+##
+# SlidayBackup 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 SlidayBackup's components, see the documentation at:
+# http://backup.github.io/backup
+#
+Model.new(:<%= @options[:trigger] %>, 'Description for <%= @options[:trigger] %>') do
+<% if @options[:splitter] %>
+<%= SlidayBackup::Template.new.result('cli/splitter') %>
+<% end; if @options[:archives] %>
+<%= SlidayBackup::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(SlidayBackup::TEMPLATE_PATH, 'cli', item, entry)) %>
+<%= SlidayBackup::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 = "SlidayBackup 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 = ["SlidayBackup %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: "SlidayBackup #{:label}"
+    # datadog.title                = "SlidayBackup #{:status}"
+    #
+    # Override Default Text
+    # Default is "SlidayBackup Notification for #{:label}"
+    # datadog.text                 = "SlidayBackup #{: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