update README to reflect for v0.4.0 changes in backup_scripts

- restart cron service after config generation

README.md

@@ -1,5 +1,7 @@
 # rsnapshot
 
+## NOTE: ! Configuration for backup_scripts changed with version 0.4.0 (it was pretty useless in prior versions) !
+
 #### Table of Contents
 
 1. [Overview](#overview)
@@ -238,6 +240,9 @@ Default is:
 Hash. Set time ranges for different backup levels. Each item (minute, hour...) allows for cron notation, an array to pick a random time from and a range to pick a random time from.
 The range notation is '$start..$end', so to pick a random hour from 8 pm to 2 am, you could set the hour of your desired backup level to 
 `[ '20..23','0..2' ]`
+For the range feature to work, hours >0 and <10 must not have a preceding zero. 
+Wrong: `00.09`
+Correct: `0..9`
 Example:
 
 ```puppet
@@ -367,7 +372,7 @@ Default is:
   $backup_scripts = {
     mysql             => {
       dbbackup_user     => 'root',
-      dbbackup_password => 'myFancyPassWord',
+      dbbackup_password => 'myPassWord',
     },
     psql                => {
       dbbackup_user     => 'postgres',
@@ -393,6 +398,8 @@ rsnapshot::hosts:
     backup_scripts:
       mysql:
       psql:
+        dbbackup_user: 'backupuser'
+        dbbackup_password: 'password'
   bazqux:de:
     backup_scripts:
       mysql:
@@ -404,6 +411,43 @@ This creates
 - a mysql and a psql backup script for `foobar.com` using the credentials `dbbackup:hunter2` for mysql and `dbbackup:yeshorsebatterystaple` for psql
 - a mysql backup script for `bazqux.de` using the credentials `myuser:mypassword`
 
+The scripts look like this:
+mysql:
+
+```bash
+#!/bin/bash
+host=bazqux.de
+user=myuser
+pass=mypassword
+
+dbs=( $(mysql -h "$host" -u "$user" -p"$pass" -e 'show databases' | sed '1d;/information_schema/d;/performance_schema/d')  )
+
+for db in "${dbs[@]}"; do
+  mysqldump --host="$host" --user="$user" --password="$pass" --single-transaction --quick --routines --ignore-table=mysql.event "$db" > "$db".sql
+  wait
+  pbzip2 -p3 "$db".sql
+done      
+
+```
+
+psql:
+
+```bash
+#!/bin/bash
+host=foobar.com
+user=backupuser
+pass=password
+
+PGPASSWORD="$pass"
+dbs=( $(psql -h "$host" -U "$user" -Atc "SELECT datname FROM pg_database WHERE NOT datistemplate AND datname <> 'postgres'")   )
+
+for db in "${dbs[@]}"; do
+  ssh -l root "$host" "pg_dump -U ${user} -Fc ${db}" > "$db".sql
+  wait
+  pbzip2 -p3 "$db".sql
+done
+```
+
 
 ### rsnapshot configuration variables
 Please read up on the following in the [rsnapshot manpage](http://linux.die.net/man/1/rsnapshot)

manifests/config.pp

@@ -5,12 +5,13 @@ class rsnapshot::config (
   $hosts          = $rsnapshot::hosts,
   $cron_dir       = $rsnapshot::cron_dir,
 ) {
+
   # these are global settings, no point in setting them per host
   $config_version         = $rsnapshot::params::config_version
   $lockpath               = pick($rsnapshot::lockpath, $rsnapshot::params::config_lockpath, '/var/run/rsnapshot')
   $conf_d                 = pick($rsnapshot::conf_d, $rsnapshot::params::conf_d, '/etc/rsnapshot')
   $snapshot_root          = pick($hosts['snapshot_root'], $rsnapshot::snapshot_root, '/backup')
-  $default_cron           = assert_empty_hash($::rsnapshot::cron)
+  $logpath                = pick($rsnapshot::logpath, $rsnapshot::params::config_logpath)
   # make sure lock path and conf path exist
   file { $conf_d:
     ensure => 'directory',
@@ -24,6 +25,10 @@ class rsnapshot::config (
   file { $snapshot_root:
     ensure => 'directory',
   }
+  file { $logpath:
+    ensure => directory,
+  }
+
   # custom function, if only a hostname is given as a param, this is an empty hash
   # the next loop would break as puppet does not allow to reassign variables
   # the function checks $hosts for elements like: 
@@ -33,7 +38,7 @@ class rsnapshot::config (
   $hosts_clean.each |String $host, $hash | {
     $backup_user            = pick($hash['backup_user'], $rsnapshot::params::config_backup_user)
     $default_backup_dirs    = pick($rsnapshot::default_backup, $rsnapshot::params::config_default_backup)
-    $backup_levels          = pick($hash['backup_levels'], $rsnapshot::params::config_backup_levels, 'weekly')
+    $backup_levels          = pick($hash['backup_levels'], $rsnapshot::backup_levels, 'weekly')
     $backup                 = $hash['backup']
     $backup_defaults        = pick($hash['backup_defaults'], $rsnapshot::params::config_backup_defaults)
     $cmd_cp                 = pick($hash['cmd_cp'], $rsnapshot::params::config_cmd_cp)
@@ -55,7 +60,6 @@ class rsnapshot::config (
     $linux_lvm_vgpath       = pick_undef($hash['linux_lvm_vgpath'], $rsnapshot::params::config_linux_lvm_vgpath)
     $linux_lvm_mountpath    = pick_undef($hash['linux_lvm_mountpath'], $rsnapshot::params::config_linux_lvm_mountpath)
     $no_create_root         = pick_undef($hash['no_create_root'], $rsnapshot::params::config_no_create_root)
-    $logpath                = pick($hash['logpath'], $rsnapshot::logpath, $rsnapshot::params::config_logpath)
     $verbose                = pick($hash['verbose'], $rsnapshot::params::config_verbose)
     $loglevel               = pick($hash['loglevel'], $rsnapshot::params::config_loglevel)
     $stop_on_stale_lockfile = pick_undef($hash['stop_on_stale_lockfile'], $rsnapshot::params::config_stop_on_stale_lockfile)
@@ -66,9 +70,9 @@ class rsnapshot::config (
     $one_fs                 = pick_undef($hash['one_fs'], $rsnapshot::params::config_one_fs)
     $interval               = pick($hash['interval'], $rsnapshot::params::config_interval)
     $retain                 = pick_undef($hash['retain'], $rsnapshot::params::config_retain)
-    $include                = pick_undef($hash['include'], $rsnapshot::params::config_include)
-    $exclude                = pick_undef($hash['exclude'], $rsnapshot::params::config_exclude)
-    $include_file           = pick_undef($hash['include_file'], $rsnapshot::params::config_include_file)
+    $include                = pick($hash['include'], [])
+    $exclude                = pick($hash['exclude'], [])
+    $include_file           = pick($hash['include_file'], $rsnapshot::params::config_include_file, "${conf_d}/${host}.include")
     $exclude_file           = pick($hash['exclude_file'], $rsnapshot::params::config_exclude_file, "${conf_d}/${host}.exclude")
     $link_dest              = pick_undef($hash['link_dest'], $rsnapshot::params::config_link_dest)
     $sync_first             = pick_undef($hash['sync_first'], $rsnapshot::params::config_sync_first)
@@ -108,19 +112,22 @@ class rsnapshot::config (
       $use_lazy_deletes_num = bool2num($use_lazy_deletes)
     }
 
-    if $include != '' {
+    $real_include = $rsnapshot::include + $include
+    unless empty($real_include)  {
       file { $include_file:
         ensure  => 'file',
         content => template('rsnapshot/include.erb'),
       }
     }
 
-    if $exclude != '' {
+    $real_exclude = $rsnapshot::exclude + $exclude
+    unless empty($real_exclude) {
       file { $exclude_file:
         ensure  => 'file',
         content => template('rsnapshot/exclude.erb'),
       }
     }
+
     concat { $config:
     }
     concat::fragment { "${config} for ${host}":
@@ -158,57 +165,16 @@ class rsnapshot::config (
     concat { $cronfile:
     }
     # create cron files for each backup level
+    # merge possible cron definitions to one
+    $real_cron = deep_merge($rsnapshot::params::cron, $rsnapshot::cron, $hash[cron])
+
     $backup_levels.each |String $level| {
+      $minute   = rand_from_array($real_cron[$level][minute],   "${host}.${level}.minute")
+      $hour     = rand_from_array($real_cron[$level][hour],     "${host}.${level}.hour")
+      $monthday = rand_from_array($real_cron[$level][monthday], "${host}.${level}.monthday")
+      $month    = rand_from_array($real_cron[$level][month],    "${host}.${level}.month")
+      $weekday  = rand_from_array($real_cron[$level][weekday],  "${host}.${level}.weekday")
 
-      # allow to globally override ranges, create random numbers for backup_levels daily, weekly, monthly
-      if has_key($hash,cron){
-        if has_key($hash[cron], $level) {
-            $cron = $hash[cron][$level]
-          } else {
-            if has_key($default_cron, $level) {
-              $cron = $default_cron[$level]
-            } else {
-              $cron = $rsnapshot::params::cron[$level]
-            }
-        }
-      } else {
-        if has_key($default_cron, $level) {
-          $cron = $default_cron[$level]
-        } else {
-          $cron = $rsnapshot::params::cron[$level]
-        }
-      }
-
-      if has_key($cron, minute) {
-        $c_min                      = $cron[minute]
-      } else {
-        $c_min                      = $rsnapshot::params::cron[$level][minute]
-      }
-      if has_key($cron, hour) {
-        $c_hour                     = $cron[hour]
-      } else {
-        $c_hour                     = $rsnapshot::params::cron[$level][hour]
-      }
-      if has_key($cron, monthday) {
-        $c_monthday                 = $cron[monthday]
-      } else {
-        $c_monthday                 = $rsnapshot::params::cron[$level][monthday]
-      }
-      if has_key($cron, month) {
-        $c_month                    = $cron[month]
-      } else {
-        $c_month                    = $rsnapshot::params::cron[$level][month]
-      }
-      if has_key($cron, weekday)  {
-        $c_weekday                  = $cron[weekday]
-      } else {
-        $c_weekday                  = $rsnapshot::params::cron[$level][weekday]
-      }
-      $minute                           = rand_from_array($c_min, "${host}.${level}.minute")
-      $hour                             = rand_from_array($c_hour, "${host}.${level}.hour")
-      $monthday                         = rand_from_array($c_monthday, "${host}.${level}.monthday")
-      $month                            = rand_from_array($c_month, "${host}.${level}.month")
-      $weekday                          = rand_from_array($c_weekday, "${host}.${level}.weekday")
       concat::fragment { "${host}.${level}":
         target  => $cronfile,
         content => template('rsnapshot/cron.erb'),

manifests/init.pp

@@ -14,17 +14,22 @@ class rsnapshot (
   $package_ensure                = $rsnapshot::params::package_ensure,
   $cron                          = $rsnapshot::params::cron,
   $backup_scripts                = $rsnapshot::params::backup_scripts,
+  $include                       = $rsnapshot::params::config_include,
   $exclude                       = $rsnapshot::params::config_exclude,
   $snapshot_root                 = $rsnapshot::params::config_snapshot_root,
+  $backup_levels                 = $rsnapshot::params::config_backup_levels,
+  $cron_service_name             = $rsnapshot::params::cron_service_name,
 ) inherits rsnapshot::params {
 
   $default_backup_scripts = $rsnapshot::params::backup_scripts + $backup_scripts
   $default_exclude        = $rsnapshot::params::config_exclude + $exclude
   if $hosts {
     class { '::rsnapshot::install': }->
-    class { '::rsnapshot::config': }
+    class { '::rsnapshot::config': }~>
+    class { '::rsnapshot::service': }
     contain '::rsnapshot::install'
     contain '::rsnapshot::config'
+    contain '::rsnapshot::service'
   }
 }
 

manifests/params.pp

@@ -7,6 +7,7 @@ class rsnapshot::params {
   $config_backup_user            = 'root'
   $package_name                  = 'rsnapshot'
   $package_ensure                = 'present'
+  $cron_service_name             = 'crond'
   $cron_dir                      = '/etc/cron.d'
   $config_backup_levels          = [ 'daily', 'weekly', 'monthly' ]
   $config_backup_defaults        = true
@@ -32,7 +33,7 @@ class rsnapshot::params {
   $config_logpath                = '/var/log/rsnapshot'
   $config_logfile                = '/var/log/rsnapshot.log'  # unused, we are logging to $logpath/$host.log
   $config_lockpath               = '/var/run/rsnapshot'
-  $config_snapshot_root          = '/backup/'
+  $config_snapshot_root          = '/backup'
   $config_no_create_root         = undef # bool, true or false
   $config_verbose                = '2'
   $config_loglevel               = '4'

manifests/service.pp

@@ -0,0 +1,10 @@
+# == Class: rsnapshot::service
+#
+# Reloads cron 
+class rsnapshot::service {
+  service { $rsnapshot::cron_service_name:
+    ensure => running,
+  }
+
+}
+

metadata.json

@@ -1,6 +1,6 @@
 {
   "name": "loomsen-rsnapshot",
-  "version": "0.4.0",
+  "version": "0.5.1",
   "author": "loomsen",
   "summary": "Configures rsnapshot.",
   "license": "Apache-2.0",

templates/exclude.erb

@@ -1,3 +1,3 @@
-<% @exclude.each do |exc| -%>
+<% @real_exclude.each do |exc| -%>
 <%= exc %>
 <% end %>

templates/include.erb

@@ -1,3 +1,3 @@
-<% @include.each do |inc| -%>
+<% @real_include.each do |inc| -%>
 <%= inc %>
 <% end %>

templates/misc.sh.erb

@@ -0,0 +1,10 @@
+#!/bin/bash
+# add custom stuff here 
+# FIXME: remember to concat for custom stuff after the last line of the puppet generated script
+<% if @osfamily == 'RedHat' -%>
+ssh <%=@host-%> rpm -qa --qf='%{name},' > packages.txt
+<%end-%>
+#
+#
+#
+# ++++++++++++++++++++++++++++++++++++++++++++

templates/mysql.sh.erb

@@ -0,0 +1,16 @@
+#!/bin/bash
+# written by Norbert Varzariu <loomsen@gmail.com>
+# This Script is triggered by rsnapshot and dumps the specified dbs on the configured host.
+#
+host=<%=@host%>
+user=<%=@dbbackup_user%>
+pass=<%=@dbbackup_password%>
+
+dbs=( $(mysql -h "$host" -u "$user" -p"$pass" -e 'show databases' | sed '1d;/information_schema/d;/performance_schema/d')  )
+
+for db in "${dbs[@]}"; do
+  mysqldump --host="$host" --user="$user" --password="$pass" --single-transaction --quick --routines --ignore-table=mysql.event "$db" > "$db".sql
+  wait
+  pbzip2 -p3 "$db".sql
+done
+

templates/psql.sh.erb

@@ -0,0 +1,17 @@
+#!/bin/bash
+# written by Norbert Varzariu <loomsen@gmail.com>
+# This Script is triggered by rsnapshot and dumps the specified dbs on the configured host.
+#
+host=<%=@host%>
+user=<%=@dbbackup_user%>
+pass=<%=@dbbackup_password%>
+
+PGPASSWORD="$pass"
+dbs=( $(psql -h "$host" -U "$user" -Atc "SELECT datname FROM pg_database WHERE NOT datistemplate AND datname <> 'postgres'")  )
+
+for db in "${dbs[@]}"; do
+  ssh -l root "$host" "pg_dump -U ${user} -Fc ${db}" > "$db".sql
+  wait
+  pbzip2 -p3 "$db".sql
+done
+

templates/rsnapshot.erb

@@ -85,12 +85,12 @@ du_args	<%= @du_args %>
 <% if @one_fs  != '' -%>
 one_fs	<%= @one_fs_num %>
 <% end -%>
-<% if @include != '' -%>
+<% unless @real_include.empty? -%>
 <% if @include_file  != '' -%>
 include_file	<%= @include_file %>
 <% end -%>
 <% end -%>
-<% if @exclude != '' -%>
+<% unless @real_exclude.empty? -%>
 <% if @exclude_file != '' -%>
 exclude_file	<%= @exclude_file %>
 <% end -%>