auto snapshots with zfs plugin

xavierlun · Nov 19th 2015

Hello

i was waiting for btrfs support in openmediavault but it does not seem under way
so i am switching my NAS from ext4 to ZFS which seems to be quite stable to what i hear

(actually i have EXT4 drive and in parallel a copy of dataset with ZFS)

up to now i am happy about the transfer

I have one question about the usage of snapshot
i have seen how to create a snapshot

but i would like to know if there is any easy way in the ZFS plugin to create the snapshot automatically on schedule (maybe in the beta version)
also to check errors it is necessary to launch some check/repaire command on a regular base ?

subzero79 · Nov 19th 2015

As I understand all of those can be fired from the scheduled task section. You need to know the zfs command to create them.
As for the scrub you can also do it the same way

ab5031 · Nov 20th 2015

I use following for daily snapshot by cron:

Code

/sbin/zfs snapshot -r pool_name/dataset@AutoD-`date +"%F"`

and "auto delete" after 7 days:

Code

/sbin/zfs list -t snapshot -o name | /bin/grep pool_name/dataset@AutoD- | /usr/bin/sort -r | /usr/bin/tail -n +7 | /usr/bin/xargs -n 1 /sbin/zfs destroy -r

xavierlun · Nov 20th 2015

thank you for clarification and detailled information

i will create the cron taks

maybe a nice feature of the ZFS plugin would be an interface to create those task easily

nicjo814 · Nov 26th 2015

Quote from xavierlun

maybe a nice feature of the ZFS plugin would be an interface to create those task easily

I have been considering this, but it's extremely difficult to create a "general and intuitive" interface that at the same time needs to be specific... For now I won't add any such feature (and rather point to cron), but if someone can come up with a nice solution and send a pull request on GitHub I'm definitely willing to consider it.

ab5031 · Nov 26th 2015

I think will be nice to add one more item named "Auto snapshot" in "Add object > Object type" with functionality same as nas4free:

nicjo814 · Nov 26th 2015

That creates the proper cron jobs I guess?

ab5031 · Nov 26th 2015

Quote from nicjo814

That creates the proper cron jobs I guess?

In cron tab added following

Code

# autosnapshot
0    */1    *    *    *    root    /usr/local/sbin/autosnapshot >/dev/null 2>&1

autosnapshot:

Bash

#!/bin/sh
#
# Part of NAS4Free (http://www.nas4free.org).
# Copyright (c) 2012-2015 The NAS4Free Project <info@nas4free.org>.
# All rights reserved.
#


TAG="Auto Snapshot"
NOW=`/bin/date +%s`
NOWHM=`/bin/date -j -f "%s" $NOW "+%H00"`


autosnapshot_config="/var/etc/autosnapshot.conf"


cat $autosnapshot_config | while read _type _path _name _recursive _timeday _timewday _timehour _timemin _lifetime _lifetimesec; do
  if [ -z "${_type}" ]; then continue; fi
  if [ "${_type}" != "daily" ]; then continue; fi
  #echo "$_type $_path $_name $_recursive $_timehour $_lifetime"
  if [ "$NOWHM" != "${_timehour}" ]; then continue; fi


  # current snapshot name
  name=`/bin/date -j -f "%s" $NOW "+${_name}"`
  if [ -z $name ]; then continue; fi;
  snapshot="${_path}@${name}"


  # oldest snapshot name
  TODAY=`date -j -f "%s" $NOW +%F`
  TODAYEPOCH=`date -j -f "%F %T" "$TODAY 12:00:00" +%s`
  DELEPOCH=`/bin/expr $TODAYEPOCH - ${_lifetimesec}`
  DELDAY=`date -j -f "%s" $DELEPOCH +%F`
  delname=`/bin/date -j -f "%F %H%M" "$DELDAY $NOWHM" "+${_name}"`
  if [ -z $delname ]; then continue; fi;
  delsnapshot="${_path}@${delname}"


  opt=""
  if [ "${_recursive}" = "true" ]; then
    opt="$opt -r"
  fi


  cmd="/sbin/zfs snapshot $opt $snapshot"
  delcmd="/sbin/zfs destroy $opt $delsnapshot"


  /usr/bin/logger -t "$TAG" "$cmd"
  eval "$cmd >/dev/null 2>&1"
  if [ ${_lifetimesec} -ne 0 ]; then
    /usr/bin/logger -t "$TAG" "$delcmd"
    eval "$delcmd >/dev/null 2>&1"
  fi
done

Display More

autoshapshot.conf:

Code

daily data auto-%Y%m%d-%H0000 false * * 2000 0000 30d 2678400

weebnuts · Sep 17th 2017

any update on adding this to the GUI? Will try the scripts given, but GUI would be nice. Was trying to use napp-it but it's scripts aren't working on OMV.

ryecoaaron · Sep 17th 2017

Quote from weebnuts

any update on adding this to the GUI?

There has been no progress in adding this to the gui.

riff-raff · Aug 11th 2018

I have an issue with autocleaning snapshots.

Cronjob creates daily snapshot:

Code

/sbin/zfs snapshot -r Storage/backup@backup_`date +"%F"`

Cronjob to check age of snapshot and deletes it after 30 days:

Code

/sbin/zfs list -t snapshot -o name | /bin/grep Storage/backup@backup_ | /usr/bin/sort -r | /usr/bin/tail -n +30 | /usr/bin/xargs -n 1 /sbin/zfs destroy -r

running this job gives me

Code

error #0:
OMV\ExecException: Failed to execute command 'export PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin; export LANG=C; export SHELL=/bin/sh; sudo --shell --non-interactive --user=root -- /sbin/zfs list -t snapshot -o name | /bin/grep Storage/backup@backup_ | /usr/bin/sort -r | /usr/bin/tail -n +30 | /usr/bin/xargs -n 1 /sbin/zfs destroy -r 2>&1' with exit code '123': missing dataset argument
usage:
	destroy [-fnpRrv] <filesystem|volume>
	destroy [-dnpRrv] <filesystem|volume>@<snap>[%<snap>][,...]
	destroy <filesystem|volume>#<bookmark>


For the property list, run: zfs set|get


For the delegated permission list, run: zfs allow|unallow in /usr/share/openmediavault/engined/rpc/cron.inc:175
Stack trace:
#0 /usr/share/php/openmediavault/rpc/serviceabstract.inc(565): OMVRpcServiceCron->{closure}('/tmp/bgstatusO5...', '/tmp/bgoutputb9...')
#1 /usr/share/openmediavault/engined/rpc/cron.inc(179): OMV\Rpc\ServiceAbstract->execBgProc(Object(Closure))
#2 [internal function]: OMVRpcServiceCron->execute(Array, Array)
#3 /usr/share/php/openmediavault/rpc/serviceabstract.inc(123): call_user_func_array(Array, Array)
#4 /usr/share/php/openmediavault/rpc/rpc.inc(86): OMV\Rpc\ServiceAbstract->callMethod('execute', Array, Array)
#5 /usr/sbin/omv-engined(536): OMV\Rpc\Rpc::call('Cron', 'execute', Array, Array, 1)
#6 {main}

Display More

is the missing argument because of there are no snapshots older than 30 days or is there another syntax mistake?

Netfreak · Jan 23rd 2023

Quote from weebnuts

any update on adding this to the GUI? Will try the scripts given, but GUI would be nice. Was trying to use napp-it but it's scripts aren't working on OMV.

I am also looking on how to do snapshots and rolebacks - This would indeed be great plugin to have in the GUI the option to make snapshots of whatever the user/owner wants (folders/sub folders etc etc...)

Netfreak · Feb 9th 2023

Quote from xavierlun

maybe a nice feature of the ZFS plugin would be an interface to create those task easily

It would be indeed be great to have the option to create snapshots and role back like they do it in Freenas/Truenas

votdev · Feb 9th 2023

Quote from Netfreak

It would be indeed be great to have the option to create snapshots and role back like they do it in Freenas/Truenas

openmediavault 6.3.0 will have that feature for BTRFS. But it does not have a restore feature by intention as mentioned in the PR. I do not like to have users running into this scenario like it is described for a different NAS. Scheduled snapshots are on the todo list.

auto snapshots with zfs plugin

Participate now!

Tags