systemd-timers instead of crons

Author: gaerfield

Makefile

@@ -17,3 +17,20 @@ install:
 	install src/zfs-auto-snapshot.8 $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
 	install -d $(DESTDIR)$(PREFIX)/sbin
 	install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot
+
+systemd:
+	install -d $(DESTDIR)/etc/systemd/system/
+	install timers/zfs-auto-snapshot-frequent.service	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-frequent.service
+	install timers/zfs-auto-snapshot-frequent.timer	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-frequent.timer
+	install timers/zfs-auto-snapshot-hourly.service	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-hourly.service
+	install timers/zfs-auto-snapshot-hourly.timer	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-hourly.timer
+	install timers/zfs-auto-snapshot-daily.service	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-daily.service
+	install timers/zfs-auto-snapshot-daily.timer	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-daily.timer
+	install timers/zfs-auto-snapshot-weekly.service	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-weekly.service
+	install timers/zfs-auto-snapshot-weekly.timer	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-weekly.timer
+	install timers/zfs-auto-snapshot-monthly.service	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-monthly.service
+	install timers/zfs-auto-snapshot-monthly.timer	$(DESTDIR)/etc/systemd/system/zfs-auto-snapshot-monthly.timer
+	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
+	install src/zfs-auto-snapshot.sh $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot

README.md

@@ -0,0 +1,43 @@
+# zfs-auto-snapshot
+
+An alternative implementation of the zfs-auto-snapshot service for Linux
+that is compatible with zfs-linux and zfs-fuse.
+
+Automatically create, rotate, and destroy periodic ZFS snapshots. This is
+the utility that creates the:
+
+* @zfs-auto-snap_frequent,
+* @zfs-auto-snap_hourly,
+* @zfs-auto-snap_daily,
+* @zfs-auto-snap_weekly, and
+* @zfs-auto-snap_monthly
+
+snapshots if it is installed.
+
+## Installation using cron
+
+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 (using the scripts in
+`etc`).
+
+```
+wget https://github.com/zfsonlinux/zfs-auto-snapshot/archive/master.zip
+unzip master.zip
+cd zfs-auto-snapshot-master
+make install
+```
+
+## Installation using systemd
+
+As suggested by [Brian Koopman][bkoop] this target uses [systemd-timers][dtim]
+instead of cron.
+
+```
+wget https://github.com/gaerfield/zfs-auto-snapshot/archive/master.zip
+unzip master.zip
+cd zfs-auto-snapshot-master
+make systemd
+```
+
+[bkoop]: https://briankoopman.com/zfs-automated-snapshots/
+[dtim]: https://wiki.archlinux.org/index.php/Systemd/Timers

src/zfs-auto-snapshot.sh

@@ -20,7 +20,7 @@
 #
 
 # Set the field separator to a literal tab and newline.
-IFS="	
+IFS="
 "
 
 # Set default program options.
@@ -74,7 +74,7 @@ print_usage ()
   -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.
-" 
+"
 }
 
 
@@ -174,7 +174,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 			else
 				WARNING_COUNT=$(( $WARNING_COUNT + 1 ))
 				continue
-			fi 
+			fi
 		fi
 
 		# Retain at most $opt_keep number of old snapshots of this filesystem,
@@ -191,7 +191,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
 				KEEP=$(( $KEEP - 1 ))
 				if [ "$KEEP" -le '0' ]
 				then
-					if do_run "zfs destroy -d $FLAGS '$jj'" 
+					if do_run "zfs destroy -d $FLAGS '$jj'"
 					then
 						DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
 					else
@@ -297,7 +297,7 @@ do
 			shift 1
 			;;
 		(--sep)
-			case "$2" in 
+			case "$2" in
 				([[:alnum:]_.:\ -])
 					:
 					;;
@@ -345,7 +345,7 @@ if [ "$#" -eq '0' ]
 then
 	print_log error "The filesystem argument list is empty."
 	exit 133
-fi 
+fi
 
 # Count the number of times '//' appears on the command line.
 SLASHIES='0'
@@ -402,7 +402,7 @@ done
 ZPOOLS_SCRUBBING=$(echo "$ZPOOL_STATUS" | awk -F ': ' \
   '$1 ~ /^ *pool$/ { pool = $2 } ; \
    $1 ~ /^ *scan$/ && $2 ~ /scrub in progress/ { print pool }' \
-  | sort ) 
+  | sort )
 
 # Get a list of pools that cannot do a snapshot.
 ZPOOLS_NOTREADY=$(echo "$ZPOOL_STATUS" | awk -F ': ' \

timers/zfs-auto-snapshot-daily.service

@@ -0,0 +1,5 @@
+[Unit]
+Description=ZFS daily snapshot service
+
+[Service]
+ExecStart=/usr/bin/zfs-auto-snapshot --quiet --syslog --label=daily --keep=31 //

timers/zfs-auto-snapshot-daily.timer

@@ -0,0 +1,10 @@
+# See systemd.timers and systemd.time manpages for details
+[Unit]
+Description=ZFS daily snapshot timer
+
+[Timer]
+OnCalendar=daily
+Persistent=true
+
+[Install]
+WantedBy=timers.target

timers/zfs-auto-snapshot-frequent.service

@@ -0,0 +1,5 @@
+[Unit]
+Description=ZFS frequent snapshot service
+
+[Service]
+ExecStart=/usr/bin/zfs-auto-snapshot --quiet --syslog --label=frequent --keep=4 //

timers/zfs-auto-snapshot-frequent.timer

@@ -0,0 +1,10 @@
+# See systemd.timers and systemd.time manpages for details
+[Unit]
+Description=ZFS frequent snapshot timer
+
+[Timer]
+OnCalendar=*:0/15
+Persistent=true
+
+[Install]
+WantedBy=timers.target

timers/zfs-auto-snapshot-hourly.service

@@ -0,0 +1,5 @@
+[Unit]
+Description=ZFS hourly snapshot service
+
+[Service]
+ExecStart=/usr/bin/zfs-auto-snapshot --quiet --syslog --label=hourly --keep=24 //

timers/zfs-auto-snapshot-hourly.timer

@@ -0,0 +1,10 @@
+# See systemd.timers and systemd.time manpages for details
+[Unit]
+Description=ZFS hourly snapshot timer
+
+[Timer]
+OnCalendar=hourly
+Persistent=true
+
+[Install]
+WantedBy=timers.target

timers/zfs-auto-snapshot-monthly.service

@@ -0,0 +1,5 @@
+[Unit]
+Description=ZFS monthly snapshot service
+
+[Service]
+ExecStart=/usr/bin/zfs-auto-snapshot  --quiet --syslog --label=monthly --keep=12 //