ZFS. ZFS-Volume incremental replication using snapshots

Description

A simple shell script for incremental replication of ZFS volumes using their snapshots

Script

#!/bin/bash

#####
#
# *zfs-volume-replication* v2023.02.02 by @ClessAlvein
#
#####


# VARS

# zfs volumes names
zfsVolOriginalFullName="d1/vmail";
zfsVolReplicaFullName="d2/vmail_replica";

# quantity of the last newest snaps, which left after new snapshot created
zfsSnapsNewestQtyToLeave="7";

# whether you want to remove or to rename and backup zfs-volume-replica with snapshots
# when something goes wrong and you have to get rid of zfs-volume-replica with its snapshots
#   "destroy" - destroy zfs-volume-replica with its snapshots in the crash case
#   "backup" - rename and backup zfs-volume-replica with its snapshots in the crash case
zfsVolReplicaCrashAction="backup"


# SCRIPT START

# get snapshots quantity
snapsOriginalQty=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
        | awk 'END {print NR}'`
snapsReplicaQty=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolReplicaFullName} \
        | awk 'END {print NR}'`

# debug
echo "Original Volume snaps Quantity: ${snapsOriginalQty}";
echo "Replica Volume snaps Quantity: ${snapsReplicaQty}";

# get the latest snaps of the original and replica volumes
snapOriginalLatestFullName=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
        | awk 'NR==1 {print $0}'`;
snapReplicaLatestFullName=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolReplicaFullName} \
        | awk 'NR==1 {print $0}'`;
snapOriginalLatestShortName=${snapOriginalLatestFullName#*@};
snapReplicaLatestShortName=${snapReplicaLatestFullName#*@};

# debug
echo "Original latest snap Full name: ${snapOriginalLatestFullName}";
echo "Replica latest snap Full name: ${snapReplicaLatestFullName}";
echo "Original latest snap Short name: ${snapOriginalLatestShortName}";
echo "Replica latest snap Short name: ${snapReplicaLatestShortName}";

# if there is NO snaps at original Volume
if [ ${snapsOriginalQty} -eq 0 ]; then
    # debug
    echo "--- There is no snaps on Original Volume! ---";
    echo "--- Creating New First Latest snap on Original Volume... ---";

    # create snap
    zfs snapshot ${zfsVolOriginalFullName}@auto-`date +%Y%m%d-%H%M%S`;

    # get snap name
    snapOriginalNewLatestFullName=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName}`;

    # debug
    echo "Original New Latest snap created: ${snapOriginalNewLatestFullName}";

    # if there are some snaps on Replica Volume
    if [ ${snapsReplicaQty} -gt 0 ]; then
        # "destroy" crash action for zfs-volume-replica
        if [ ${zfsVolReplicaCrashAction} == "destroy" ]; then
            # debug
            echo "--- Destroying all snaps on Replica Volume... ---";

            # destroy all snaps at Replica Volume
            #zfs destroy ${zfsVolReplicaFullName}@%;
        fi

        # "backup" crash action for zfs-volume-replica
        if [ ${zfsVolReplicaCrashAction} == "backup" ]; then
            # debug
            echo "--- Renaming and Backuping Replica Volume with all snaps... ---";

            # rename and backup zfs-volume-replica
            zfs rename ${zfsVolReplicaFullName} ${zfsVolReplicaFullName}_bkup--`date +%Y-%m-%d--%H-%M-%S`;
        fi
    fi

    # debug
    echo "--- Making replication... ---";

    # make replication
    zfs send -Pev ${snapOriginalNewLatestFullName} | zfs recv -F ${zfsVolReplicaFullName};
fi

# if there is ONE or MORE snaps at original Volume
if [ ${snapsOriginalQty} -ge 1 ]; then
    # if the Latest snap on Original Volume and the snap on Replica Volume names are _THE SAME_
    if [[ "${snapOriginalLatestShortName}" == "${snapReplicaLatestShortName}" ]]; then
        # debug
        echo "Latest snap names on both volumes are _THE SAME_!";

        # debug
        echo "--- Creating New Latest snap on Original Volume... ---";

        # create snap
        zfs snapshot ${zfsVolOriginalFullName}@auto-`date +%Y%m%d-%H%M%S`;

        # get names of the latest new snap and snap before the latest
        snapOriginalNewLatestFullName=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
                | awk 'NR==1 {print $0}'`;
        snapOriginalBeforeNewLatestFullName=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
                | awk 'NR==2 {print $0}'`;

        # debug
        echo "Original New Latest snap: ${snapOriginalNewLatestFullName}";
        echo "Original Before New Latest snap: ${snapOriginalBeforeNewLatestFullName}";

        # debug
        echo "--- Making replication... ---";

        # make a replication
        zfs send -Pev -i ${snapOriginalBeforeNewLatestFullName} ${snapOriginalNewLatestFullName} | zfs recv -F ${zfsVolReplicaFullName};

        # debug
        echo "--- Destroying old replicas... ---";

        # destroy old snaps, leave only the newest snaps at the both Volumes - original and replica
        zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
                | awk -v i=${zfsSnapsNewestQtyToLeave} 'FNR>i {print $0}' | xargs -n 1 zfs destroy;
        zfs list -H -t snapshot -o name -S creation -r ${zfsVolReplicaFullName} \
                | awk -v i=${zfsSnapsNewestQtyToLeave} 'FNR>i {print $0}' | xargs -n 1 zfs destroy;

    # if the Latest snap on Original Volume and the snap on Replica Volume names are _NOT THE SAME_
    else
        # debug
        echo "--- Latest snap names on both volumes are _NOT THE SAME_! It's necessary to remove all snaps on Replica Volume or to rename Replica Volume! ---";

        # if there are some snaps on Replica Volume
        if [ ${snapsReplicaQty} -gt 0 ]; then
            # "destroy" crash action for zfs-volume-replica
            if [ ${zfsVolReplicaCrashAction} == "destroy" ]; then
                # debug
                echo "--- Destroying all snaps on Replica Volume... ---";

                # destroy all snaps at Replica Volume
                #zfs destroy ${zfsVolReplicaFullName}@%;
            fi

            # "backup" crash action for zfs-volume-replica
            if [ ${zfsVolReplicaCrashAction} == "backup" ]; then
                # debug
                echo "--- Renaming and Backuping Replica Volume with all snaps... ---";

                # rename and backup zfs-volume-replica
                zfs rename ${zfsVolReplicaFullName} ${zfsVolReplicaFullName}_bkup--`date +%Y-%m-%d--%H-%M-%S`;
            fi
        fi

        # debug
        echo "--- Creating New Latest snap on Original Replica... ---";

        # create snap at original Volume
        zfs snapshot ${zfsVolOriginalFullName}@auto-`date +%Y%m%d-%H%M%S`;

        # get the latest snap on Original Volume
        snapOriginalNewLatestFullName=`zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
                | awk 'NR==1 {print $0}'`;

        # debug
        echo "Original New Latest snap: ${snapOriginalNewLatestFullName}";

        # debug
        echo "--- Making replication... ---";

        # make a replication
        zfs send -Pev -R ${snapOriginalNewLatestFullName} | zfs recv -F ${zfsVolReplicaFullName};

        # debug
        echo "-- Destroying old snapshots... ---";

        # destroy old snaps, leave only some newest snaps at the both Volumes - original and replica
        zfs list -H -t snapshot -o name -S creation -r ${zfsVolOriginalFullName} \
                | awk -v i=${zfsSnapsNewestQtyToLeave} 'FNR>i {print $0}' | xargs -n 1 zfs destroy;
        zfs list -H -t snapshot -o name -S creation -r ${zfsVolReplicaFullName} \
                | awk -v i=${zfsSnapsNewestQtyToLeave} 'FNR>i {print $0}' | xargs -n 1 zfs destroy;
    fi
fi

Usage

• Create ZFS-Volume

zfs create -V 10G raid1/vmail

• Edit VARS
• Run

./zfs-volume-replication.sh

Hints

• zfs-volume-source CAN be mounted, attached as ISCSI-extent (for ISCSI-target), etc.
• zfs-volume-destination-replica _MUSTN'T_ be mounted, attached as ISCSI-extent (for ISCSI-target), etc., otherwise you'll get an error: dataset is busy.