third-party-mirrors/zfs_autobackup
1
0
Fork 1
mirror of https://github.com/psy0rz/zfs_autobackup.git synced 2025-06-03 01:30:57 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:psy0rz/zfs_autobackup

Browse Source
This commit is contained in:
Edwin Eefting 2020-05-11 12:02:22 +02:00
commit de877362c9
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -84,7 +84,7 @@ On older servers you might have to use easy_install
Its also possible to just download <https://raw.githubusercontent.com/psy0rz/zfs_autobackup/master/bin/zfs-autobackup> and run it directly. Its also possible to just download <https://raw.githubusercontent.com/psy0rz/zfs_autobackup/master/bin/zfs-autobackup> and run it directly.
The only requirement that is sometimes missing is the `argparse` python module. Optionally you can install `colorma` for colors. The only requirement that is sometimes missing is the `argparse` python module. Optionally you can install `colorama` for colors.
It should work with python 2.7 and higher. It should work with python 2.7 and higher.
@ -324,7 +324,7 @@ Snapshots on the source that still have to be send to the target wont be destroy
## Tips ## Tips
* Use ```--debug``` if something goes wrong and you want to see the commands that are executed. This will also stop at the first error. * Use ```--debug``` if something goes wrong and you want to see the commands that are executed. This will also stop at the first error.
* You can split up the snapshotting and sending tasks by creating two cronjobs. Use ```--no-send``` for the snapshotter-cronjob and use ```--no-snapshot``` for the send-cronjob. This is usefull if you only want to send at night or if your send take too long. * You can split up the snapshotting and sending tasks by creating two cronjobs. Use ```--no-send``` for the snapshotter-cronjob and use ```--no-snapshot``` for the send-cronjob. This is useful if you only want to send at night or if your send take too long.
* Set the ```readonly``` property of the target filesystem to ```on```. This prevents changes on the target side. (Normally, if there are changes the next backup will fail and will require a zfs rollback.) Note that readonly means you cant change the CONTENTS of the dataset directly. Its still possible to receive new datasets and manipulate properties etc. * Set the ```readonly``` property of the target filesystem to ```on```. This prevents changes on the target side. (Normally, if there are changes the next backup will fail and will require a zfs rollback.) Note that readonly means you cant change the CONTENTS of the dataset directly. Its still possible to receive new datasets and manipulate properties etc.
* Use ```--clear-refreservation``` to save space on your backup server. * Use ```--clear-refreservation``` to save space on your backup server.
* Use ```--clear-mountpoint``` to prevent the target server from mounting the backupped filesystem in the wrong place during a reboot. * Use ```--clear-mountpoint``` to prevent the target server from mounting the backupped filesystem in the wrong place during a reboot.
@ -409,9 +409,9 @@ optional arguments:
10,1d1w,1w1m,1m1y 10,1d1w,1w1m,1m1y
--other-snapshots Send over other snapshots as well, not just the ones --other-snapshots Send over other snapshots as well, not just the ones
created by this tool. created by this tool.
--no-snapshot Dont create new snapshots (usefull for finishing --no-snapshot Dont create new snapshots (useful for finishing
uncompleted backups, or cleanups) uncompleted backups, or cleanups)
--no-send Dont send snapshots (usefull for cleanups, or if you --no-send Dont send snapshots (useful for cleanups, or if you
want a separate send-cronjob) want a separate send-cronjob)
--min-change MIN_CHANGE --min-change MIN_CHANGE
Number of bytes written after which we consider a Number of bytes written after which we consider a
@ -419,9 +419,9 @@ optional arguments:
--allow-empty If nothing has changed, still create empty snapshots. --allow-empty If nothing has changed, still create empty snapshots.
(same as --min-change=0) (same as --min-change=0)
--ignore-replicated Ignore datasets that seem to be replicated some other --ignore-replicated Ignore datasets that seem to be replicated some other
way. (No changes since lastest snapshot. Usefull for way. (No changes since lastest snapshot. Useful for
proxmox HA replication) proxmox HA replication)
--no-holds Dont lock snapshots on the source. (Usefull to allow --no-holds Dont lock snapshots on the source. (Useful to allow
proxmox HA replication to switches nodes) proxmox HA replication to switches nodes)
--resume Support resuming of interrupted transfers by using the --resume Support resuming of interrupted transfers by using the
zfs extensible_dataset feature (both zpools should zfs extensible_dataset feature (both zpools should
@ -454,7 +454,7 @@ optional arguments:
care! (implies --rollback) care! (implies --rollback)
--ignore-transfer-errors --ignore-transfer-errors
Ignore transfer errors (still checks if received Ignore transfer errors (still checks if received
filesystem exists. usefull for acltype errors) filesystem exists. useful for acltype errors)
--raw For encrypted datasets, send data exactly as it exists --raw For encrypted datasets, send data exactly as it exists
on disk. on disk.
--test dont change anything, just show what would be done --test dont change anything, just show what would be done

20
bin/zfs-autobackup
View File

@ -311,7 +311,7 @@ class ExecuteNode:
def __init__(self, ssh_config=None, ssh_to=None, readonly=False, debug_output=False): def __init__(self, ssh_config=None, ssh_to=None, readonly=False, debug_output=False):
"""ssh_config: custom ssh config """ssh_config: custom ssh config
ssh_to: server you want to ssh to. none means local ssh_to: server you want to ssh to. none means local
readonly: only execute commands that don't make any changes (usefull for testing-runs) readonly: only execute commands that don't make any changes (useful for testing-runs)
debug_output: show output and exit codes of commands in debugging output. debug_output: show output and exit codes of commands in debugging output.
""" """
@ -625,7 +625,7 @@ class ZfsDataset():
@cached_property @cached_property
def exists(self): def exists(self):
"""check if dataset exists. """check if dataset exists.
Use force to force a specific value to be cached, if you already know. Usefull for performance reasons""" Use force to force a specific value to be cached, if you already know. Useful for performance reasons"""
if self.force_exists!=None: if self.force_exists!=None:
@ -1312,7 +1312,7 @@ class ZfsNode(ExecuteNode):
#always output for debugging offcourse #always output for debugging offcourse
self.debug(prefix+line.rstrip()) self.debug(prefix+line.rstrip())
#actual usefull info #actual useful info
if len(progress_fields)>=3: if len(progress_fields)>=3:
if progress_fields[0]=='full' or progress_fields[0]=='size': if progress_fields[0]=='full' or progress_fields[0]=='size':
self._progress_total_bytes=int(progress_fields[2]) self._progress_total_bytes=int(progress_fields[2])
@ -1380,7 +1380,7 @@ class ZfsNode(ExecuteNode):
pools[pool].append(snapshot) pools[pool].append(snapshot)
#add snapshot to cache (also usefull in testmode) #add snapshot to cache (also useful in testmode)
dataset.snapshots.append(snapshot) #NOTE: this will trigger zfs list dataset.snapshots.append(snapshot) #NOTE: this will trigger zfs list
if not pools: if not pools:
@ -1459,13 +1459,13 @@ class ZfsAutobackup:
parser.add_argument('target_path', help='Target ZFS filesystem') parser.add_argument('target_path', help='Target ZFS filesystem')
parser.add_argument('--other-snapshots', action='store_true', help='Send over other snapshots as well, not just the ones created by this tool.') parser.add_argument('--other-snapshots', action='store_true', help='Send over other snapshots as well, not just the ones created by this tool.')
parser.add_argument('--no-snapshot', action='store_true', help='Don\'t create new snapshots (usefull for finishing uncompleted backups, or cleanups)') parser.add_argument('--no-snapshot', action='store_true', help='Don\'t create new snapshots (useful for finishing uncompleted backups, or cleanups)')
parser.add_argument('--no-send', action='store_true', help='Don\'t send snapshots (usefull for cleanups, or if you want a serperate send-cronjob)') parser.add_argument('--no-send', action='store_true', help='Don\'t send snapshots (useful for cleanups, or if you want a serperate send-cronjob)')
parser.add_argument('--min-change', type=int, default=1, help='Number of bytes written after which we consider a dataset changed (default %(default)s)') parser.add_argument('--min-change', type=int, default=1, help='Number of bytes written after which we consider a dataset changed (default %(default)s)')
parser.add_argument('--allow-empty', action='store_true', help='If nothing has changed, still create empty snapshots. (same as --min-change=0)') parser.add_argument('--allow-empty', action='store_true', help='If nothing has changed, still create empty snapshots. (same as --min-change=0)')
parser.add_argument('--ignore-replicated', action='store_true', help='Ignore datasets that seem to be replicated some other way. (No changes since lastest snapshot. Usefull for proxmox HA replication)') parser.add_argument('--ignore-replicated', action='store_true', help='Ignore datasets that seem to be replicated some other way. (No changes since lastest snapshot. Useful for proxmox HA replication)')
parser.add_argument('--no-holds', action='store_true', help='Don\'t lock snapshots on the source. (Usefull to allow proxmox HA replication to switches nodes)') parser.add_argument('--no-holds', action='store_true', help='Don\'t lock snapshots on the source. (Useful to allow proxmox HA replication to switches nodes)')
#not sure if this ever was usefull: #not sure if this ever was useful:
# parser.add_argument('--ignore-new', action='store_true', help='Ignore filesystem if there are already newer snapshots for it on the target (use with caution)') # parser.add_argument('--ignore-new', action='store_true', help='Ignore filesystem if there are already newer snapshots for it on the target (use with caution)')
parser.add_argument('--resume', action='store_true', help='Support resuming of interrupted transfers by using the zfs extensible_dataset feature (both zpools should have it enabled) Disadvantage is that you need to use zfs recv -A if another snapshot is created on the target during a receive. Otherwise it will keep failing.') parser.add_argument('--resume', action='store_true', help='Support resuming of interrupted transfers by using the zfs extensible_dataset feature (both zpools should have it enabled) Disadvantage is that you need to use zfs recv -A if another snapshot is created on the target during a receive. Otherwise it will keep failing.')
@ -1480,7 +1480,7 @@ class ZfsAutobackup:
parser.add_argument('--set-properties', type=str, help='List of propererties to override when receiving filesystems. (you can still restore them with zfs inherit -S)') parser.add_argument('--set-properties', type=str, help='List of propererties to override when receiving filesystems. (you can still restore them with zfs inherit -S)')
parser.add_argument('--rollback', action='store_true', help='Rollback changes to the latest target snapshot before starting. (normally you can prevent changes by setting the readonly property on the target_path to on)') parser.add_argument('--rollback', action='store_true', help='Rollback changes to the latest target snapshot before starting. (normally you can prevent changes by setting the readonly property on the target_path to on)')
parser.add_argument('--destroy-incompatible', action='store_true', help='Destroy incompatible snapshots on target. Use with care! (implies --rollback)') parser.add_argument('--destroy-incompatible', action='store_true', help='Destroy incompatible snapshots on target. Use with care! (implies --rollback)')
parser.add_argument('--ignore-transfer-errors', action='store_true', help='Ignore transfer errors (still checks if received filesystem exists. usefull for acltype errors)') parser.add_argument('--ignore-transfer-errors', action='store_true', help='Ignore transfer errors (still checks if received filesystem exists. useful for acltype errors)')
parser.add_argument('--raw', action='store_true', help='For encrypted datasets, send data exactly as it exists on disk.') parser.add_argument('--raw', action='store_true', help='For encrypted datasets, send data exactly as it exists on disk.')