From dc6f5ddcd9465a62c342cb2b80e56c012061702b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Roland=20St=C3=BChmer?= Date: Wed, 16 Apr 2014 13:47:29 +0200 Subject: [PATCH 1/8] Fix SNAPNAME to contain the DATE if label is empty When I didn't specify a `--label` on the commandline, the SNAPNAME was missing the $DATE component --- src/zfs-auto-snapshot.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/zfs-auto-snapshot.sh b/src/zfs-auto-snapshot.sh index cd20042..e60a437 100755 --- a/src/zfs-auto-snapshot.sh +++ b/src/zfs-auto-snapshot.sh @@ -507,7 +507,7 @@ SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event'" DATE=$(date --utc +%F-%H%M) # The snapshot name after the @ symbol. -SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label-$DATE}" +SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label}-$DATE" # The expression for matching old snapshots. -YYYY-MM-DD-HHMM SNAPGLOB="$opt_prefix${opt_label:+?$opt_label}????????????????" From a1b89b6fefc8563bffe0a74582633530fae4837c Mon Sep 17 00:00:00 2001 From: Borut Mrak Date: Wed, 23 Apr 2014 07:19:38 +0200 Subject: [PATCH 2/8] Makefile: * Remove PREFIX from cron scripts - they should always end up in /etc. * Leave PREFIX for man page and program, and set it to /usr/local by default. --- Makefile | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/Makefile b/Makefile index a3f606d..155e578 100644 --- a/Makefile +++ b/Makefile @@ -1,16 +1,18 @@ +PREFIX := /usr/local + all: install: - install -d $(DESTDIR)$(PREFIX)/etc/cron.d - install -d $(DESTDIR)$(PREFIX)/etc/cron.daily - install -d $(DESTDIR)$(PREFIX)/etc/cron.hourly - install -d $(DESTDIR)$(PREFIX)/etc/cron.weekly - install -d $(DESTDIR)$(PREFIX)/etc/cron.monthly - install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)$(PREFIX)/etc/cron.d/zfs-auto-snapshot - install etc/zfs-auto-snapshot.cron.hourly $(DESTDIR)$(PREFIX)/etc/cron.hourly/zfs-auto-snapshot - install etc/zfs-auto-snapshot.cron.daily $(DESTDIR)$(PREFIX)/etc/cron.daily/zfs-auto-snapshot - install etc/zfs-auto-snapshot.cron.weekly $(DESTDIR)$(PREFIX)/etc/cron.weekly/zfs-auto-snapshot - install etc/zfs-auto-snapshot.cron.monthly $(DESTDIR)$(PREFIX)/etc/cron.monthly/zfs-auto-snapshot + install -d $(DESTDIR)/etc/cron.d + install -d $(DESTDIR)/etc/cron.daily + install -d $(DESTDIR)/etc/cron.hourly + install -d $(DESTDIR)/etc/cron.weekly + install -d $(DESTDIR)/etc/cron.monthly + install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/zfs-auto-snapshot + install etc/zfs-auto-snapshot.cron.hourly $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot + install etc/zfs-auto-snapshot.cron.daily $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot + install etc/zfs-auto-snapshot.cron.weekly $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot + install etc/zfs-auto-snapshot.cron.monthly $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot install -d $(DESTDIR)$(PREFIX)/share/man/man8 install src/zfs-auto-snapshot.8 $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8 install -d $(DESTDIR)$(PREFIX)/sbin From da5a8bd5b787e03c4ca1ea35e2a7cc6dddaa4356 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Ma=C5=82ecki?= Date: Wed, 6 Aug 2014 22:38:02 +0200 Subject: [PATCH 3/8] Add `--{pre,post}-snapshot` for pre and post creation hook --- src/zfs-auto-snapshot.sh | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/zfs-auto-snapshot.sh b/src/zfs-auto-snapshot.sh index e60a437..2c87bd0 100755 --- a/src/zfs-auto-snapshot.sh +++ b/src/zfs-auto-snapshot.sh @@ -39,6 +39,8 @@ opt_setauto='' opt_syslog='' opt_skip_scrub='' opt_verbose='' +opt_pre_snapshot='' +opt_post_snapshot='' # Global summary statistics. DESTRUCTION_COUNT='0' @@ -156,8 +158,10 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...] for ii in $TARGETS do + do_run "$opt_pre_snapshot $ii $NAME" if do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" then + do_run "$opt_post_snapshot $ii $NAME" SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 )) else WARNING_COUNT=$(( $WARNING_COUNT + 1 )) @@ -198,6 +202,7 @@ GETOPT=$(getopt \ --longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \ --longoptions=event:,keep:,label:,prefix:,sep: \ --longoptions=debug,help,quiet,syslog,verbose \ + --longoptions=pre-snapshot:,post-snapshot: \ --options=dnshe:l:k:p:rs:qgv \ -- "$@" ) \ || exit 128 @@ -308,6 +313,14 @@ do opt_verbose='1' shift 1 ;; + (--pre-snapshot) + opt_pre_snapshot="$2" + shift 2 + ;; + (--post-snapshot) + opt_post_snapshot="$2" + shift 2 + ;; (--) shift 1 break From c08f366c1cf7abb8cfdc14c6e3b9c2da3e98795a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Ma=C5=82ecki?= Date: Thu, 7 Aug 2014 01:55:43 +0200 Subject: [PATCH 4/8] Abort if pre snapshot hook returns non-zero --- src/zfs-auto-snapshot.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/zfs-auto-snapshot.sh b/src/zfs-auto-snapshot.sh index 2c87bd0..8ae5f53 100755 --- a/src/zfs-auto-snapshot.sh +++ b/src/zfs-auto-snapshot.sh @@ -159,7 +159,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...] for ii in $TARGETS do do_run "$opt_pre_snapshot $ii $NAME" - if do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" + if [ $? -eq 0 ] && do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" then do_run "$opt_post_snapshot $ii $NAME" SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 )) From 10f9b3e3361f59ff2992602cd1c6d494a5c579f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20Ma=C5=82ecki?= Date: Thu, 7 Aug 2014 02:03:25 +0200 Subject: [PATCH 5/8] Document `--{pre,post}-snapshot --- src/zfs-auto-snapshot.8 | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/zfs-auto-snapshot.8 b/src/zfs-auto-snapshot.8 index fbec696..a2680cf 100644 --- a/src/zfs-auto-snapshot.8 +++ b/src/zfs-auto-snapshot.8 @@ -64,6 +64,15 @@ Snapshot named filesystem and all descendants. \fB\-v\fR, \fB\-\-verbose\fR Print info messages. .TP +\fB\-\-pre-snapshot\fR +Command to run before snapshotting. It is passed the +filesystem and snapshot name. If it returns non-zero, +snapshotting this filesystem is aborted. +.TP +\fB\-\-post-snapshot\fR +Command to run after snapshotting. It is passed the +filesystem and snapshot name. +.TP name Filesystem and volume names, or '//' for all ZFS datasets. .SH SEE ALSO From bfe4c911a89105cb51745192621b6ddbdb693a81 Mon Sep 17 00:00:00 2001 From: Mike Baynton Date: Sat, 9 Aug 2014 17:23:02 -0500 Subject: [PATCH 6/8] Make --{pre,post}-snapshot optional, add --destroy-only, revise docs --- src/zfs-auto-snapshot.8 | 26 ++++++++++++++----- src/zfs-auto-snapshot.sh | 56 ++++++++++++++++++++++++++++++---------- 2 files changed, 62 insertions(+), 20 deletions(-) diff --git a/src/zfs-auto-snapshot.8 b/src/zfs-auto-snapshot.8 index a2680cf..51fdc7f 100644 --- a/src/zfs-auto-snapshot.8 +++ b/src/zfs-auto-snapshot.8 @@ -64,14 +64,26 @@ Snapshot named filesystem and all descendants. \fB\-v\fR, \fB\-\-verbose\fR Print info messages. .TP -\fB\-\-pre-snapshot\fR -Command to run before snapshotting. It is passed the -filesystem and snapshot name. If it returns non-zero, -snapshotting this filesystem is aborted. +\fB\-\-pre-snapshot\fR=\fICOMMAND\fR +Command to run before each dataset is snapshotted. +It is passed the dataset and snapshot name. If it +returns non-zero, snapshotting this dataset is +aborted. .TP -\fB\-\-post-snapshot\fR -Command to run after snapshotting. It is passed the -filesystem and snapshot name. +\fB\-\-post-snapshot\fR=\fICOMMAND\fR +Command to run after each dataset is snapshotted. +It is passed the dataset and snapshot name. +.TP +\fB\-\-destroy-only\fR +Do not create new snapshots, but do destroy older +snapshots. Has no effect unless used with \fB\-k\fR. +.IP +A non-obvious use may be constructon of cron jobs or +scripts that run pre-snapshot command(s), then run +zfs-auto-snapshot (without \fB\-k\fR) to quickly +snapshot all datasets, then run post-snapshot +command(s) and clean up with zfs-auto-snapshot +\fB\-\-destroy-only\fR. .TP name Filesystem and volume names, or '//' for all ZFS datasets. diff --git a/src/zfs-auto-snapshot.sh b/src/zfs-auto-snapshot.sh index 8ae5f53..2a82c9a 100755 --- a/src/zfs-auto-snapshot.sh +++ b/src/zfs-auto-snapshot.sh @@ -41,6 +41,7 @@ opt_skip_scrub='' opt_verbose='' opt_pre_snapshot='' opt_post_snapshot='' +opt_do_snapshots=1 # Global summary statistics. DESTRUCTION_COUNT='0' @@ -71,6 +72,7 @@ print_usage () -g, --syslog Write messages into the system log. -r, --recursive Snapshot named filesystem and all descendants. -v, --verbose Print info messages. + --destroy-only Only destroy older snapshots, do not create new ones. name Filesystem and volume names, or '//' for all ZFS datasets. " } @@ -150,6 +152,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...] local GLOB="$4" local TARGETS="$5" local KEEP='' + local RUNSNAP=1 # global DESTRUCTION_COUNT # global SNAPSHOT_COUNT @@ -158,15 +161,21 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...] for ii in $TARGETS do - do_run "$opt_pre_snapshot $ii $NAME" - if [ $? -eq 0 ] && do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" + if [ -n "$opt_do_snapshots" ] then - do_run "$opt_post_snapshot $ii $NAME" - SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 )) - else - WARNING_COUNT=$(( $WARNING_COUNT + 1 )) - continue - fi + if [ "$opt_pre_snapshot" != "" ] + then + do_run "$opt_pre_snapshot $ii $NAME" || RUNSNAP=0 + fi + if [ $RUNSNAP -eq 1 ] && do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'" + then + [ "$opt_post_snapshot" != "" ] && do_run "$opt_post_snapshot $ii $NAME" + SNAPSHOT_COUNT=$(( $SNAPSHOT_COUNT + 1 )) + else + WARNING_COUNT=$(( $WARNING_COUNT + 1 )) + continue + fi + fi # Retain at most $opt_keep number of old snapshots of this filesystem, # including the one that was just recently created. @@ -202,7 +211,7 @@ GETOPT=$(getopt \ --longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \ --longoptions=event:,keep:,label:,prefix:,sep: \ --longoptions=debug,help,quiet,syslog,verbose \ - --longoptions=pre-snapshot:,post-snapshot: \ + --longoptions=pre-snapshot:,post-snapshot:,destroy-only \ --options=dnshe:l:k:p:rs:qgv \ -- "$@" ) \ || exit 128 @@ -321,6 +330,10 @@ do opt_post_snapshot="$2" shift 2 ;; + (--destroy-only) + opt_do_snapshots='' + shift 1 + ;; (--) shift 1 break @@ -525,11 +538,28 @@ SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label}-$DATE" # The expression for matching old snapshots. -YYYY-MM-DD-HHMM SNAPGLOB="$opt_prefix${opt_label:+?$opt_label}????????????????" -test -n "$TARGETS_REGULAR" \ - && print_log info "Doing regular snapshots of $TARGETS_REGULAR" +if [ -n "$opt_do_snapshots" ] +then + test -n "$TARGETS_REGULAR" \ + && print_log info "Doing regular snapshots of $TARGETS_REGULAR" -test -n "$TARGETS_RECURSIVE" \ - && print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE" + test -n "$TARGETS_RECURSIVE" \ + && print_log info "Doing recursive snapshots of $TARGETS_RECURSIVE" + + if test -n "$opt_keep" && [ "$opt_keep" -ge "1" ] + then + print_log info "Destroying all but the newest $opt_keep snapshots of each dataset." + fi +elif test -n "$opt_keep" && [ "$opt_keep" -ge "1" ] +then + test -n "$TARGETS_REGULAR" \ + && print_log info "Destroying all but the newest $opt_keep snapshots of $TARGETS_REGULAR" + + test -n "$TARGETS_RECURSIVE" \ + && print_log info "Recursively destroying all but the newest $opt_keep snapshots of $TARGETS_RECURSIVE" +else + print_log notice "Only destroying snapshots, but count of snapshots to preserve not given. Nothing to do." +fi test -n "$opt_dry_run" \ && print_log info "Doing a dry run. Not running these commands..." From bc1b65a66ed2de0e44126b30b773e64f76e5f9e8 Mon Sep 17 00:00:00 2001 From: virtualguy Date: Mon, 18 Aug 2014 21:38:32 +1200 Subject: [PATCH 7/8] Update README Add some simple installation instructions --- README | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README b/README index 745cf7d..dd3d6bc 100644 --- a/README +++ b/README @@ -10,3 +10,12 @@ snapshots if it is installed. This program is a posixly correct bourne shell script. It depends only on the zfs utilities and cron, and can run in the dash shell. + + +Installation: +------------- + +wget https://github.com/zfsonlinux/zfs-auto-snapshot/archive/master.zip +unzip master.zip +cd zfs-auto-snapshot-master +make install From d5cb31aaae90600b71f98037e3445edd53f28329 Mon Sep 17 00:00:00 2001 From: Darik Horn Date: Mon, 13 Oct 2014 23:12:53 -0500 Subject: [PATCH 8/8] Install the cron.d part without the execute bit. Resolve this lintian error: E: zfs-auto-snapshot: bad-permissions-for-etc-cron.d-script etc/cron.d/zfs-auto-snapshot 0755 != 0644 W: zfs-auto-snapshot: executable-not-elf-or-script etc/cron.d/zfs-auto-snapshot This should also resolve a related failure on Arch Linux. Closes: zfsonlinux/zfs-auto-snapshot#4 Thanks: @bitloggerig Thanks: @scottj97 --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 155e578..4b02b40 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,7 @@ install: install -d $(DESTDIR)/etc/cron.hourly install -d $(DESTDIR)/etc/cron.weekly install -d $(DESTDIR)/etc/cron.monthly - install etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/zfs-auto-snapshot + install -m 0644 etc/zfs-auto-snapshot.cron.frequent $(DESTDIR)/etc/cron.d/zfs-auto-snapshot install etc/zfs-auto-snapshot.cron.hourly $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot install etc/zfs-auto-snapshot.cron.daily $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot install etc/zfs-auto-snapshot.cron.weekly $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot