3 # backup-script system for cloning systems using rsync
4 # Copyright (c)2008-2016 Alexander Barton <alex@barton.de>
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10 # Please read the file COPYING, README and AUTHORS for more information.
14 PIDFILE="/var/run/$NAME.pid"
22 declare -i count_all=0
23 declare -i count_started=0
25 declare -i count_ok_vanished=0
29 # Default settings, can be overwritten in backup-script.conf:
30 [ -d "/usr/local/etc/backup-script.d" ] \
31 && conf_d="/usr/local/etc/backup-script.d" \
32 || conf_d="/etc/backup-script.d"
35 default_backup_type="rsync"
36 default_source_root="/"
37 default_files="running-config"
38 default_target="/var/backups"
40 default_ssh_args_add=""
41 default_rsync_args_add=""
42 default_exclude_args_add=""
43 default_exclude_dirs_add=""
48 default_job_pre_exec=""
49 default_job_post_exec=""
53 echo "Usage: $NAME [<options>] [<system> [<system> [...]]]"
55 echo " -n, --dry-run Test run only, don't copy any data."
56 echo " -p, --progress Show progress, see rsync(1)."
57 echo " -t TAG, --tag TAG Only run jobs with tag TAG."
59 echo "When no <system> is given, all defined systems are used."
67 if [ -n "$post_exec" ]; then
68 echo "Executing \"$post_exec\" ..."
71 echo "Warning: post-exec command failed!"
80 echo "--> Got break signal, cleaning up & aborting ..."
83 echo -n "Aborted: "; date
93 echo "Running job ${what}-exec command ..."
95 && cmd="$ssh_cmd ${user}@${system} $cmd"
96 echo -n "Start date (${what}-exec): "; date
98 if [ "$DRYRUN" -eq 0 ]; then
99 $SHELL -c "$cmd"; local ret=$?
101 echo " *** Trial run, not executing ${what}-exec command!"
105 && echo "The ${what}-exec command completed with status 0, OK." \
106 || echo "The ${what}-exec command completed with ERRORS, code $ret!"
113 while [ -n "$dir" ]; do
114 findmnt -fn -o FSTYPE --raw "$dir" 2>/dev/null; local r=$?
115 if [ $r -eq 0 ]; then
117 elif [ $r -eq 127 ]; then
121 dir=$(dirname "$dir") || return 1
130 dir=$(dirname "$volume")
134 btrfs subvolume create "$volume" >/dev/null || return 1
137 zfs create "$(echo "$volume" | cut -c2-)" || return 1
140 echo "CreateSubvolume: Incompatible FS type \"$fs\" on \"$dir\"!"
154 dir=$(dirname "source")
155 fs=$(GetFS "$source")
158 btrfs subvolume snapshot "$source" "$snapshot" >/dev/null || return 1
161 zfs snapshot "$snapshot" || return 1
162 link_name="$(echo "$snapshot" | cut -d@ -f2-)"
164 "current/.zfs/snapshot/$link_name" \
165 "$(dirname "$volume")/$link_name"
168 echo "CloneSubvolume: Incompatible FS type \"$fs\" on \"$source\"!"
179 fs=$(GetFS "$source")
182 mv "$source" "$target" || return 1
186 "$(echo "$source" | cut -c2-)" \
187 "$(echo "$target" | cut -c2-)" \
191 echo "RenameSubvolume: Incompatible FS type \"$fs\" on \"$source\"!"
203 fs=$(GetFS "$volume")
206 btrfs subvolume delete "$volume" >/dev/null || return 1
209 id="$(basename "$volume")"
210 if [ -h "$volume" ]; then
211 snapshot="$(dirname "$volume")/current@$id"
215 zfs destroy -r "$(echo "$snapshot" | cut -c2-)" >/dev/null || return 1
216 [ -h "$volume" ] && rm "$volume"
219 echo "DeleteSubvolume: Incompatible FS type \"$fs\" on \"$volume\"!"
225 Initialize_Last_SysTarget_Snapshot() {
230 fs=$(GetFS "$sys_target")
233 # Search directory of last generation, if any
234 last=$(ls -1d "$sys_target"/[0-9]* 2>/dev/null | sort -r | head -n1)
235 if [ -n "$last" ]; then
236 if [ ! -d "$last" ]; then
237 echo "Last snapshot \"$last\" seems not to be a directory!? \"$system\" skipped!"
242 sys_target="$sys_target/$(date +%Y%m%d-%H%M%S)"
243 snapshot="$sys_target"
246 # On ZFS, the last generation is always named "current"
247 if [ -e "$sys_target/current" ]; then
248 last="$sys_target/current"
249 if [ "$(uname)" = "Linux" ]; then
250 date=$(LC_ALL=C stat "$1" | grep "^Modify: " \
251 | cut -d':' -f2- | cut -d. -f1)
253 date=$(LC_ALL=C stat -f "%Sc" "$1")
255 date=$(echo "$date" | sed -e's/^ //g' -e 's/[-:]//g' -e 's/ /-/g')
259 date="$(date +%Y%m%d-%H%M%S)"
261 snapshot="$(echo "$sys_target/current" | cut -c2-)@$date"
262 sys_target="$sys_target/current"
265 echo "Initialize_Last_SysTarget_Snapshot: Incompatible FS type \"$fs\" on \"$sys_target\"!"
271 # Search configuration file (last one is used as default!)
273 "/usr/local/etc/backup-script.conf" \
274 "/etc/backup-script.conf" \
275 "${conf_d}/backup-script.conf" \
276 "/usr/local/etc/backup-script.conf" \
278 [ -r "$conf" ] && break
281 # Read in configuration file
282 config_info="Configuration file is \"$conf\""
283 if [ -r "$conf" ]; then
284 # shellcheck source=/dev/null
287 config_info="${config_info} (not readable, using defaults)"
289 config_info="${config_info},\nusing \"$conf_d\" as configuration directory."
291 while [ $# -gt 0 ]; do
300 shift; TAG="$1"; shift
301 [ -n "$TAG" ] || Usage
311 echo -n "Started: "; date
312 echo -e "$config_info"
314 # Check rsync and its protocol version
315 rsync=$(which "rsync" 2>/dev/null)
316 if [ $? -ne 0 ]; then
317 echo "Failed to detect rsync(1)! Is it installed in your \$PATH?"
320 rsync_proto=$($rsync --version 2>/dev/null | head -n 1 | sed 's/.* protocol version \([0-9]*\)$/\1/')
321 if [ $? -ne 0 ]; then
322 echo "Failed to detect protocol version of $rsync!"
325 echo "Rsync command is $rsync, protocol version $rsync_proto."
327 [[ -n "$TAG" ]] && echo "Running jobs tagged with \"$TAG\"."
330 trap GotSignal SIGINT
332 if [ $# -ge 1 ]; then
334 if [ ! -r "${conf_d}/$s" ]; then
335 echo "$NAME: Can' read \"${conf_d}/$s\"!"
338 sys+=("${conf_d}/$s")
344 # check and create PID file
345 if [ -e "$PIDFILE" ]; then
346 echo "Lockfile \"$PIDFILE\" already exists."
347 echo "Is an other instance still running?"
349 echo -n "Aborted: "; date
353 touch "$PIDFILE" 2>/dev/null
354 if [ $? -ne 0 ]; then
355 echo "Warning: can't create PID file \"$PIDFILE\"!"
358 echo "$$" >>"$PIDFILE"
361 if [ -n "$pre_exec" ]; then
362 echo "Executing \"$pre_exec\" ..."
364 if [ $? -ne 0 ]; then
365 echo "Error: pre-exec command failed!"; echo
367 echo "Aborting backup."; echo
374 for f in "${sys[@]}"; do
375 [[ -r "$f" && -f "$f" ]] || continue
377 fname=$(basename "$f")
379 "backup-script.conf"|*.sh)
384 # Set global defaults
386 backup_type="$default_backup_type"
388 source_root="$default_source_root"
389 files="$default_files"
390 target="$default_target"
391 ssh_args_add="$default_ssh_args_add"
392 rsync_args_add="$default_rsync_args_add"
393 exclude_args_add="$default_exclude_args_add"
394 exclude_dirs_add="$default_exclude_dirs_add"
395 compress="$default_compress"
397 local="$default_local"
398 generations="$default_generations"
399 job_pre_exec="$default_job_pre_exec"
400 job_post_exec="$default_job_post_exec"
403 # Compatibility with backup-pull(1) script: Save global values ...
404 pre_exec_saved="$pre_exec"
405 post_exec_saved="$post_exec"
407 # Compatibility with backup-pull(1) script: Set defaults
413 # Read in system configuration file
414 # shellcheck source=/dev/null
417 # Compatibility with backup-pull(1) script: Fix up configuration
418 [[ "$system" = "$fname" && -n "$host" ]] \
420 [[ "$source_root" = "$default_source_root" && -n "$source" ]] \
421 && source_root="$source"
422 [[ -z "$job_pre_exec" && -n "$pre_exec" ]] \
423 && job_pre_exec="$pre_exec"
424 [[ -z "$job_post_exec" && -n "$post_exec" ]] \
425 && job_post_exec="$post_exec"
427 # Compatibility with backup-pull(1) script: Restore global values ...
428 pre_exec="$pre_exec_saved"
429 post_exec="$post_exec_saved"
431 # Validate configuration
432 if [[ "$system" = "localhost" || "$system" = "127.0.0.1" ]]; then
438 # Add "NONE" tag when no tags are given in the config file:
439 [[ -z "$tags" ]] && tags="NONE"
441 [[ "$local" -eq 1 ]] && tags="$tags,LOCAL"
443 if [[ -n "$TAG" && "$TAG" != "ALL" ]]; then
444 echo "$tags" | grep -E "(^|,)$TAG(,|$)" >/dev/null 2>&1
445 if [ $? -ne 0 ]; then
446 if [ "$DRYRUN" -ne 0 ]; then
447 echo "Tags of system \"$system\" don't match \"$TAG\": \"$tags\". Skipped."
454 # Make sure "source_root" ends with a slash ("/")
455 case "$source_root" in
459 source_root="$source_root/"
462 # Make sure "target" DOESN'T end with a slash ("/")
465 target=$( echo "$target" | sed -e 's/\/$//g' )
469 [ "$system" = "$fname" ] \
470 && systxt="\"$system\"" \
471 || systxt="\"$fname\" [\"$system\"]"
473 && echo "Working on $systxt ..." \
474 || echo "Working on $systxt (local system) ..."
476 count_all=$count_all+1
478 # Check target directory
479 if [ -z "$target" ]; then
480 echo "No target directory specified for \"$system\"!? Skipped!"
483 if [ ! -d "$target" ]; then
484 echo "Target \"$target\" is not a directory!? \"$system\" skipped!"
488 sys_target="$target/$fname"
489 sys_root="$sys_target"
490 if [[ "$DRYRUN" -eq 0 && ! -e "$sys_target" ]]; then
491 if [ $generations -gt 0 ]; then
492 CreateSubvolume "$sys_target"
494 mkdir -p "$sys_target"
496 if [ $? -ne 0 ]; then
497 echo "Can't create \"$sys_target\"!? \"$system\" skipped!"
502 if [[ "$local" -eq 0 && "$ping" -ne 0 ]]; then
503 # Check if system is alive
504 ping -c 1 "$system" >/dev/null 2>&1
505 if [ $? -ne 0 ]; then
506 echo "Host \"$system\" seems not to be alive!? Skipped."
509 echo "OK, host \"$system\" seems to be alive."
512 if [ $generations -gt 0 ]; then
513 # Make sure no old backup is stored in system directory
514 if [ -e "$sys_target/.stamp" ]; then
515 # There seems to be a genearation-less backup in the
517 echo "Target directory \"$sys_target\" seems to be unclean!? \"$system\" skipped!"
521 Initialize_Last_SysTarget_Snapshot "$sys_target" || continue
523 if [[ -n "$last" && ! -e "$last/.stamp" ]]; then
524 # Old backup directory without "stamp file", continue
525 echo "Found incomplete snapshot in \"$last\", reusing and renaming it ..."
526 RenameSubvolume "$last" "$sys_target"
527 if [ $? -ne 0 ]; then
528 echo "Failed to rename last snapshot \"$last\" to \"$sys_target\"!? \"$system\" skipped!"
531 elif [ -n "$last" ]; then
532 # Old backup directory found, create new snapshot
533 echo "Found last snapshot in \"$last\"."
534 if [ "$DRYRUN" -eq 0 ]; then
535 CloneSubvolume "$last" "$sys_target" "$snapshot"; r=$?
536 if [ $r -ne 0 ]; then
537 echo "Can't create snapshot \"$snapshot\" of \"$last\", code $r!? \"$system\" skipped!"
540 echo "Created new snapshot in \"$snapshot\"."
542 echo " *** Trial run, not creating new snapshot in \"$snapshot\"!"
545 # No old backup found, create new subvolume
546 if [ "$DRYRUN" -eq 0 ]; then
547 CreateSubvolume "$sys_target"; r=$?
548 if [ $r -ne 0 ]; then
549 echo "Can't create subvolume \"$sys_target\", code $r!? \"$system\" skipped!"
552 echo "Created new subvolume in \"$sys_target\"."
554 echo " *** Trial run, not creating new subvolume \"$sys_target\"!"
560 [ -n "$ssh_args_add" ] && ssh_cmd="$ssh_cmd $ssh_args_add"
562 # execute job "pre-exec" command, if any
563 if [ -n "$job_pre_exec" ]; then
564 ExecJob pre "$job_pre_exec" ; ret=$?
565 if [ $ret -ne 0 ]; then
566 [ $ret -ne 99 ] && count_started=$count_started+1
567 echo "Pre-exec command failed, \"$system\" skipped!"
572 # prepare (remote) command ...
573 if [[ "$backup_type" == "rsync" ]]; then
574 cmd="$rsync --archive --timeout=900"
575 [ "$compress" -ne 0 ] && cmd="$cmd --compress"
576 [ "$local" -eq 0 ] && cmd="$cmd --rsh=\"$ssh_cmd\""
577 cmd="$cmd --delete-during --delete-excluded --sparse"
578 if [ "$VERBOSE" -gt 0 ]; then
579 [ "$rsync_proto" -ge 31 ] \
580 && cmd="$cmd --info=progress2" \
581 || cmd="$cmd --progress"
584 if [ "$source_root" = "$default_source_root" ]; then
594 "/var/cache/apt/**" \
598 cmd="$cmd --exclude=$dir"
601 [ -n "$exclude_args_add" ] && cmd="$cmd $exclude_args_add"
602 for dir in $exclude_dirs_add; do
603 cmd="$cmd --exclude=$dir"
605 [ -n "$rsync_args_add" ] && cmd="$cmd $rsync_args_add"
609 && cmd="$cmd ${user}@${system}:$source_root $sys_target/" \
610 || cmd="$cmd $source_root $sys_target/"
611 elif [[ "$backup_type" == "scp" ]]; then
613 [ "$VERBOSE" -eq 0 ] && cmd="$cmd -q"
614 for file in $files; do
615 cmd="$cmd ${user}@${system}:$file $sys_target/"
618 echo "Backup type \"$backup_type\" undefined, \"$system\" skipped!"
622 echo "Backing up to \"$sys_target\" ..."
623 echo -n "Start date: "; date
625 count_started=$count_started+1
628 if [ "$DRYRUN" -eq 0 ]; then
629 stamp_file="$sys_target/.stamp"
632 # Execute backup command:
633 start_t=$(date "+%s")
634 $SHELL -c "$cmd"; ret=$?
637 echo "code=$ret" >"$stamp_file"
638 echo "start_t=$start_t" >>"$stamp_file"
639 echo "end_t=$end_t" >>"$stamp_file"
640 echo "cmd='$cmd'" >>"$stamp_file"
641 echo "backup_host='`hostname -f`'" >>"$stamp_file"
642 echo "backup_user='`id -un`'" >>"$stamp_file"
644 echo " *** Trial run, not executing save command!"
648 if [ $ret -eq 20 ]; then
649 echo "Backup of \"$system\" interrupted. Aborting ..."
653 echo -n "End date: "; date
654 if [[ $ret -eq 0 || $ret -eq 24 ]]; then
655 [ $ret -eq 24 ] && count_ok_vanished=$count_ok_vanished+1
657 echo "System \"$system\" completed with status $ret, OK."
658 [ "$DRYRUN" -gt 0 ] || count_ok=$count_ok+1
661 echo "System \"$system\" completed with ERRORS, code $ret!"
664 # execute job "post-exec" command, if any
665 if [ -n "$job_post_exec" ]; then
666 ExecJob post "$job_post_exec"
669 if [ $generations -gt 0 ]; then
670 # Update "latest" symlink
671 if [ "$DRYRUN" -eq 0 ]; then
672 rm -f "$sys_root/latest"
673 ln -s "$sys_target" "$sys_root/latest"
675 # Clean up old generations
676 declare -i gen_count=$generations+2
677 to_delete=$(ls -1t "$sys_root" 2>/dev/null | tail -n+$gen_count | sort)
678 if [[ -n "$to_delete" && $ok -eq 1 ]]; then
679 [ "$DRYRUN" -eq 0 ] \
680 && echo "Deleting old backup generations (keep $generations) ..." \
681 || echo " *** Trial run, not deleting old generations:"
682 for delete in $to_delete; do
683 dir="$sys_root/$delete"
684 if [ ! -e "$dir/.stamp" ]; then
685 echo "Not deleting \"$dir\", not a backup directory!?"
688 last=$(stat "$dir/.stamp" 2>/dev/null | grep "^Modify: " \
689 | cut -d':' -f2- | cut -d. -f1)
690 echo "Removing backup from" $last "..."
691 if [ "$DRYRUN" -eq 0 ]; then
692 DeleteSubvolume "$dir"
694 echo "Failed to delete \"$dir\"!"
697 echo -n "Clean up finished: "; date
698 elif [ -n "$to_delete" ]; then
699 echo "There have been errors, not cleaning up old generations!"
701 echo "Nothing to clean up (keep up to $generations generations)."
705 destinations="$destinations $target"
711 if [ "$DRYRUN" -eq 0 ]; then
714 for dest in $(echo $destinations | sed -e 's/ /\n/g' | sort | uniq); do
718 paths_zfs="$paths_zfs $dest"
724 if [ -n "$paths" ]; then
728 if [ -n "$paths_zfs" ]; then
736 echo -n "Done: "; date
738 [ $count_all -eq 1 ] && s="" || s="s"
739 echo " - $count_all job$s defined,"
740 [ $count_started -eq 1 ] && s="" || s="s"
741 echo " - $count_started job$s started,"
742 echo " - $count_ok done without errors."
745 if [ $count_started -ne $count_ok ]; then
746 echo "-----> THERE HAVE BEEN ERRORS! <-----"
749 elif [ $count_all -ne $count_started ]; then