ZFS Snapshot Replicator
Project description
zfs-replicate
https://github.com/alunduil/zfs-replicate
By Alex Brandt alunduil@gmail.com
Description
zfs-replicate sends all ZFS snapshots to a remote host via SSH. zfs-replicate does not create ZFS snapshots.
zfs-replicate is based on autorepl.py used by FreeNAS.
zfs-replicate is related to several other projects which fit other niches:
- sanoid: A full snapshot management system. Its companion application, syncoid, handles replication with many available options.
- zfs-replicate (BASH): A very similar project. The major differences are configuration style (our project uses parameters whereas this project uses a BASH script), and the system expectations (e.g., logging controls).
- znapzend: Another scheduling and replicating system.
- zrep: A SH script with several control commands for snapshot replication.
Terms of Use
You are free to copy, modify, and distribute zfs-replicate with attribution under the terms of the BSD-2-Clause licence. See the LICENSE for details.
Prerequisites
- A remote system with a ZFS filesystem and the zfs CLI tools
- SSH access to that remote system
- If you're not using the root user remotely:
- Ensure the user can mount filesystems
- FreeBSD:
sysctl -w vfs.usermount=1
- FreeBSD:
- Add ZFS permissions
- Command:
zfs allow ${USER} ${PERMISSIONS} ${BACKUP_DATASET}
- Permissions
- clone
- create
- destroy
- hold
- mount
- promote
- quota
- readonly
- receive
- rename
- reservation
- rollback
- send
- snapshot
- Command:
- Ensure the user can mount filesystems
- A local ZFS filesystem and zfs CLI tools
N.B., don't use the root user to access your remote system.
How to use zfs-replicate
poetry install
poetry run -- zfs-replicate --help
Documentation
zfs-replicate --help
: Help for zfs-replicate.- LICENSE: Licence file explaining usage of zfs-replicate.
- Survey of ZFS Replication Tools: Overview of various ZFS replication tools and their uses.
- Working With Oracle Solaris ZFS Snapshots and Clones: Oracle's guide to working with ZFS snapshots.
- ZFS REMOTE REPLICATION SCRIPT WITH REPORTING
- ZFS replication without using Root user: How to configure ZFS replication for a non-root user.
Getting Support
- GitHub issues: Report any problems or features requests to GitHub issues.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
zfs_replicate-2.2.0.tar.gz
(13.0 kB
view hashes)
Built Distribution
Close
Hashes for zfs_replicate-2.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 138fdf00fa613ad73d3d36a3262d9f9d079a2bcc7ae466c3e47d0233220cb288 |
|
MD5 | eaa035e8603adbc49548c66111880de6 |
|
BLAKE2b-256 | 1ee93fa19a2510e9d907d9a30e533954a680fd715805f40be0a9154d9d3aac72 |