mirror of
https://github.com/zfsonlinux/zfs-auto-snapshot.git
synced 2025-08-16 07:38:12 +02:00
Compare commits
58 Commits
upstream/1
...
master
Author | SHA1 | Date | |
---|---|---|---|
92db087bb0 | |||
f938d9cc1c | |||
4538217932 | |||
99e1a6103d | |||
86a95095ee | |||
363a847ee3 | |||
12945110d3 | |||
d5646c901e | |||
4a59d0d615 | |||
ef7ae674f5 | |||
b0a5909335 | |||
3689b2c43d | |||
d27bbfa650 | |||
897ca026e1 | |||
3e48c8956e | |||
3efc478828 | |||
c99de67c63 | |||
4425d681f3 | |||
6f6d1202cf | |||
6ee4553cf6 | |||
6c7da10e24 | |||
3d9992b086 | |||
f145cf6e07 | |||
838b03b41f | |||
e1268767b8 | |||
e93096c2d9 | |||
1ae1adc5f0 | |||
41eddc97cc | |||
2b7b694a95 | |||
277287f824 | |||
d49be6a2de | |||
2e1f309131 | |||
1666623191 | |||
739972f18a | |||
8c45add2c0 | |||
9c6f065589 | |||
62f5f7d920 | |||
b74769894c | |||
11130ba8d6 | |||
27413ac798 | |||
c4ad5eeac5 | |||
6e32b25d8f | |||
b2e97c5fe0 | |||
d3bdd2dc23 | |||
f2767ad43a | |||
d5cb31aaae | |||
1ce72681bf | |||
a0df1ebcc1 | |||
0be4466869 | |||
9d2398ed8e | |||
bc1b65a66e | |||
bfe4c911a8 | |||
10f9b3e336 | |||
c08f366c1c | |||
da5a8bd5b7 | |||
a1b89b6fef | |||
d625c53af1 | |||
dc6f5ddcd9 |
9
CHANGELOG
Normal file
9
CHANGELOG
Normal file
@ -0,0 +1,9 @@
|
||||
[ 1.2.5 (Unreleased) ]
|
||||
|
||||
* Start a changelog
|
||||
* Accept PR#94 from aimileus/macos
|
||||
- Replace --utc longform option with -u for macos compatibility
|
||||
* Accept PR#107 from ArakniD/master
|
||||
- Add optional label for snap removals
|
||||
|
||||
-- Jonathan Carter 2019-09-25, 15:24 SAST
|
33
Makefile
33
Makefile
@ -1,17 +1,28 @@
|
||||
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 -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
|
||||
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 -m 0644 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
|
||||
|
||||
uninstall:
|
||||
rm $(DESTDIR)/etc/cron.d/zfs-auto-snapshot
|
||||
rm $(DESTDIR)/etc/cron.hourly/zfs-auto-snapshot
|
||||
rm $(DESTDIR)/etc/cron.daily/zfs-auto-snapshot
|
||||
rm $(DESTDIR)/etc/cron.weekly/zfs-auto-snapshot
|
||||
rm $(DESTDIR)/etc/cron.monthly/zfs-auto-snapshot
|
||||
rm $(DESTDIR)$(PREFIX)/share/man/man8/zfs-auto-snapshot.8
|
||||
rm $(DESTDIR)$(PREFIX)/sbin/zfs-auto-snapshot
|
||||
|
9
README
9
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/upstream/1.2.4.tar.gz
|
||||
tar -xzf 1.2.4.tar.gz
|
||||
cd zfs-auto-snapshot-upstream-1.2.4
|
||||
make install
|
||||
|
@ -1,2 +1,6 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Only call zfs-auto-snapshot if it's available
|
||||
which zfs-auto-snapshot > /dev/null || exit 0
|
||||
|
||||
exec zfs-auto-snapshot --quiet --syslog --label=daily --keep=31 //
|
||||
|
@ -1,3 +1,3 @@
|
||||
PATH="/usr/bin:/bin:/usr/sbin:/sbin"
|
||||
PATH="/usr/bin:/bin:/usr/local/sbin:/usr/sbin:/sbin"
|
||||
|
||||
*/15 * * * * root zfs-auto-snapshot -q -g --label=frequent --keep=4 //
|
||||
*/15 * * * * root which zfs-auto-snapshot > /dev/null || exit 0 ; zfs-auto-snapshot --quiet --syslog --label=frequent --keep=4 //
|
||||
|
@ -1,2 +1,6 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Only call zfs-auto-snapshot if it's available
|
||||
which zfs-auto-snapshot > /dev/null || exit 0
|
||||
|
||||
exec zfs-auto-snapshot --quiet --syslog --label=hourly --keep=24 //
|
||||
|
@ -1,2 +1,6 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Only call zfs-auto-snapshot if it's available
|
||||
which zfs-auto-snapshot > /dev/null || exit 0
|
||||
|
||||
exec zfs-auto-snapshot --quiet --syslog --label=monthly --keep=12 //
|
||||
|
@ -1,2 +1,6 @@
|
||||
#!/bin/sh
|
||||
|
||||
# Only call zfs-auto-snapshot if it's available
|
||||
which zfs-auto-snapshot > /dev/null || exit 0
|
||||
|
||||
exec zfs-auto-snapshot --quiet --syslog --label=weekly --keep=8 //
|
||||
|
@ -64,6 +64,27 @@ Snapshot named filesystem and all descendants.
|
||||
\fB\-v\fR, \fB\-\-verbose\fR
|
||||
Print info messages.
|
||||
.TP
|
||||
\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=\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 construction 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.
|
||||
.SH SEE ALSO
|
||||
|
144
src/zfs-auto-snapshot.sh
Executable file → Normal file
144
src/zfs-auto-snapshot.sh
Executable file → Normal file
@ -39,6 +39,10 @@ opt_setauto=''
|
||||
opt_syslog=''
|
||||
opt_skip_scrub=''
|
||||
opt_verbose=''
|
||||
opt_pre_snapshot=''
|
||||
opt_post_snapshot=''
|
||||
opt_do_snapshots=1
|
||||
opt_min_size=0
|
||||
|
||||
# Global summary statistics.
|
||||
DESTRUCTION_COUNT='0'
|
||||
@ -69,6 +73,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.
|
||||
"
|
||||
}
|
||||
@ -106,7 +111,7 @@ print_log () # level, message, ...
|
||||
;;
|
||||
(inf*)
|
||||
# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.info $*
|
||||
test -n "$opt_verbose" && echo $*
|
||||
test -z "$opt_quiet" && test -n "$opt_verbose" && echo $*
|
||||
;;
|
||||
(deb*)
|
||||
# test -n "$opt_syslog" && logger -t "$opt_prefix" -p daemon.debug $*
|
||||
@ -148,6 +153,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
|
||||
@ -156,13 +162,37 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
||||
|
||||
for ii in $TARGETS
|
||||
do
|
||||
if do_run "zfs snapshot $PROPS $FLAGS '$ii@$NAME'"
|
||||
# Check if size check is > 0
|
||||
size_check_skip=0
|
||||
if [ "$opt_min_size" -gt 0 ]
|
||||
then
|
||||
bytes_written=`zfs get -Hp -o value written $ii`
|
||||
kb_written=$(( $bytes_written / 1024 ))
|
||||
if [ "$kb_written" -lt "$opt_min_size" ]
|
||||
then
|
||||
size_check_skip=1
|
||||
if [ $opt_verbose -gt 0 ]
|
||||
then
|
||||
echo "Skipping target $ii, only $kb_written kB written since last snap. opt_min_size is $opt_min_size"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ -n "$opt_do_snapshots" -a "$size_check_skip" -eq 0 ]
|
||||
then
|
||||
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.
|
||||
@ -178,7 +208,7 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
||||
KEEP=$(( $KEEP - 1 ))
|
||||
if [ "$KEEP" -le '0' ]
|
||||
then
|
||||
if do_run "zfs destroy $FLAGS '$jj'"
|
||||
if do_run "zfs destroy -d $FLAGS '$jj'"
|
||||
then
|
||||
DESTRUCTION_COUNT=$(( $DESTRUCTION_COUNT + 1 ))
|
||||
else
|
||||
@ -194,11 +224,19 @@ do_snapshots () # properties, flags, snapname, oldglob, [targets...]
|
||||
# main ()
|
||||
# {
|
||||
|
||||
GETOPT=$(getopt \
|
||||
if [ "$(uname)" = "Darwin" ]; then
|
||||
GETOPT_BIN="$(brew --prefix gnu-getopt 2> /dev/null || echo /usr/local)/bin/getopt"
|
||||
else
|
||||
GETOPT_BIN="getopt"
|
||||
fi
|
||||
|
||||
GETOPT=$($GETOPT_BIN \
|
||||
--longoptions=default-exclude,dry-run,fast,skip-scrub,recursive \
|
||||
--longoptions=event:,keep:,label:,prefix:,sep: \
|
||||
--longoptions=debug,help,quiet,syslog,verbose \
|
||||
--options=dnshe:l:k:p:rs:qgv \
|
||||
--longoptions=pre-snapshot:,post-snapshot:,destroy-only \
|
||||
--longoptions=min-size: \
|
||||
--options=dnshe:l:k:p:rs:qgvm: \
|
||||
-- "$@" ) \
|
||||
|| exit 128
|
||||
|
||||
@ -257,6 +295,10 @@ do
|
||||
opt_label="$2"
|
||||
shift 2
|
||||
;;
|
||||
(-m|--min-size)
|
||||
opt_min_size="$2"
|
||||
shift 2
|
||||
;;
|
||||
(-p|--prefix)
|
||||
opt_prefix="$2"
|
||||
while test "${#opt_prefix}" -gt '0'
|
||||
@ -283,7 +325,7 @@ do
|
||||
shift 1
|
||||
;;
|
||||
(--sep)
|
||||
case "$2" in
|
||||
case "$2" in
|
||||
([[:alnum:]_.:\ -])
|
||||
:
|
||||
;;
|
||||
@ -308,6 +350,18 @@ do
|
||||
opt_verbose='1'
|
||||
shift 1
|
||||
;;
|
||||
(--pre-snapshot)
|
||||
opt_pre_snapshot="$2"
|
||||
shift 2
|
||||
;;
|
||||
(--post-snapshot)
|
||||
opt_post_snapshot="$2"
|
||||
shift 2
|
||||
;;
|
||||
(--destroy-only)
|
||||
opt_do_snapshots=''
|
||||
shift 1
|
||||
;;
|
||||
(--)
|
||||
shift 1
|
||||
break
|
||||
@ -319,7 +373,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'
|
||||
@ -341,16 +395,33 @@ fi
|
||||
ZPOOL_STATUS=$(env LC_ALL=C zpool status 2>&1 ) \
|
||||
|| { print_log error "zpool status $?: $ZPOOL_STATUS"; exit 135; }
|
||||
|
||||
|
||||
ZFS_LIST=$(env LC_ALL=C zfs list -H -t filesystem,volume -s name \
|
||||
-o name,com.sun:auto-snapshot,com.sun:auto-snapshot:"$opt_label") \
|
||||
|| { print_log error "zfs list $?: $ZFS_LIST"; exit 136; }
|
||||
|
||||
if [ -n "$opt_fast_zfs_list" ]
|
||||
then
|
||||
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name|grep $opt_prefix |awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' |sort -r -k1,1 -k2,2|awk '{ print substr( $0, 17, length($0) )}') \
|
||||
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||
# Check if a snapshot label is being used, in which case restrict the old
|
||||
# snapshot removal to only snapshots with the same label format
|
||||
if [ -n "$opt_label" ]
|
||||
then
|
||||
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name | \
|
||||
grep "$opt_prefix"_"$opt_label" | \
|
||||
awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' | \
|
||||
sort -r -k1,1 -k2,2 | \
|
||||
awk '{ print substr( $0, 17, length($0) )}') \
|
||||
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||
else
|
||||
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -o name -s name | \
|
||||
grep $opt_prefix | \
|
||||
awk '{ print substr( $0, length($0) - 14, length($0) ) " " $0}' | \
|
||||
sort -r -k1,1 -k2,2 | \
|
||||
awk '{ print substr( $0, 17, length($0) )}') \
|
||||
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||
fi
|
||||
else
|
||||
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
|
||||
SNAPSHOTS_OLD=$(env LC_ALL=C zfs list -H -t snapshot -S creation -o name) \
|
||||
|| { print_log error "zfs list $?: $SNAPSHOTS_OLD"; exit 137; }
|
||||
fi
|
||||
|
||||
@ -410,11 +481,20 @@ do
|
||||
# Just testing "$ii" != ${ii#$jj} would incorrectly match.
|
||||
iii="$ii/"
|
||||
|
||||
# Exclude datasets that are not named on the command line.
|
||||
|
||||
# Exclude datasets
|
||||
# * that are not named on the command line or
|
||||
# * those whose prefix is not on the command line (if --recursive flag is set)
|
||||
IN_ARGS='0'
|
||||
for jj in "$@"
|
||||
do
|
||||
# Ibid regarding iii.
|
||||
jjj="$jj/"
|
||||
|
||||
if [ "$jj" = '//' -o "$jj" = "$ii" ]
|
||||
then
|
||||
IN_ARGS=$(( $IN_ARGS + 1 ))
|
||||
elif [ -n "$opt_recursive" -a "$iii" != "${iii#$jjj}" ]
|
||||
then
|
||||
IN_ARGS=$(( $IN_ARGS + 1 ))
|
||||
fi
|
||||
@ -504,19 +584,37 @@ SNAPPROP="-o com.sun:auto-snapshot-desc='$opt_event'"
|
||||
|
||||
# ISO style date; fifteen characters: YYYY-MM-DD-HHMM
|
||||
# On Solaris %H%M expands to 12h34.
|
||||
DATE=$(date --utc +%F-%H%M)
|
||||
# We use the shortfirm -u here because --utc is not supported on macos.
|
||||
DATE=$(date -u +%F-%H%M)
|
||||
|
||||
# The snapshot name after the @ symbol.
|
||||
SNAPNAME="$opt_prefix${opt_label:+$opt_sep$opt_label-$DATE}"
|
||||
SNAPNAME="${opt_prefix:+$opt_prefix$opt_sep}${opt_label:+$opt_label}-$DATE"
|
||||
|
||||
# The expression for matching old snapshots. -YYYY-MM-DD-HHMM
|
||||
SNAPGLOB="$opt_prefix${opt_label:+?$opt_label}????????????????"
|
||||
SNAPGLOB="${opt_prefix:+$opt_prefix$opt_sep}${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..."
|
||||
|
Reference in New Issue
Block a user