zfs_snapshot_setup.sh

#!/bin/sh
# =============================================================================
# OPNsense ZFS Snapshot Automation with Advanced Retention Rules
# =============================================================================
# This script set creates daily and weekly ZFS snapshots with
# automatic retention policy:
# - Daily snapshots: 30 days retention
# - Weekly snapshots: 52 weeks retention
# =============================================================================

# -----------------------------------------------------------------------------
# 1. DAILY BOOT ENVIRONMENT SCRIPT: /root/zfs_daily_snapshot.sh
# -----------------------------------------------------------------------------
cat > /root/zfs_daily_snapshot.sh << 'EOF'
#!/bin/sh

# Configuration
SNAPSHOT_PREFIX="daily"
RETENTION_DAYS=30

# Logging
LOG_FILE="/var/log/zfs_daily_snapshots.log"
DATE=$(date '+%Y-%m-%d %H:%M:%S')

echo "[$DATE] Starting daily Boot Environment creation..." >> $LOG_FILE

# Create Boot Environment with timestamp
BE_NAME="${SNAPSHOT_PREFIX}-$(date '+%Y%m%d')"

# Create Boot Environment (will be displayed in Web GUI)
echo "[$DATE] Creating Boot Environment: $BE_NAME" >> $LOG_FILE
bectl create "$BE_NAME" 2>> $LOG_FILE
if [ $? -eq 0 ]; then
    echo "[$DATE] Success: Boot Environment $BE_NAME created" >> $LOG_FILE
else
    echo "[$DATE] Error creating Boot Environment: $BE_NAME" >> $LOG_FILE
fi

# Delete old Boot Environments (older than RETENTION_DAYS)
CUTOFF_DATE=$(date -j -f '%Y-%m-%d' -v-${RETENTION_DAYS}d "$(date '+%Y-%m-%d')" '+%Y%m%d')

echo "[$DATE] Cleaning up Boot Environments older than $RETENTION_DAYS days (before $CUTOFF_DATE)..." >> $LOG_FILE

# List all Boot Environments and delete old ones
bectl list -H | grep "^${SNAPSHOT_PREFIX}-" | while read line; do
    be_name=$(echo "$line" | awk '{print $1}')
    be_date=$(echo "$be_name" | sed "s/${SNAPSHOT_PREFIX}-//")
    
    # Check if BE is older than cutoff date
    if [ "$be_date" -lt "$CUTOFF_DATE" ]; then
        # Check if BE is not active (no N or R flag)
        if ! echo "$line" | grep -q "[NR]"; then
            echo "[$DATE] Deleting old Boot Environment: $be_name" >> $LOG_FILE
            bectl destroy "$be_name" 2>> $LOG_FILE
            if [ $? -eq 0 ]; then
                echo "[$DATE] Successfully deleted: $be_name" >> $LOG_FILE
            else
                echo "[$DATE] Error deleting: $be_name" >> $LOG_FILE
            fi
        else
            echo "[$DATE] Skipping active Boot Environment: $be_name" >> $LOG_FILE
        fi
    fi
done

echo "[$DATE] Daily Boot Environment process completed." >> $LOG_FILE
EOF

# -----------------------------------------------------------------------------
# 2. WEEKLY BOOT ENVIRONMENT SCRIPT: /root/zfs_weekly_snapshot.sh
# -----------------------------------------------------------------------------
cat > /root/zfs_weekly_snapshot.sh << 'EOF'
#!/bin/sh

# Configuration
SNAPSHOT_PREFIX="weekly"
RETENTION_WEEKS=52

# Logging
LOG_FILE="/var/log/zfs_weekly_snapshots.log"
DATE=$(date '+%Y-%m-%d %H:%M:%S')

echo "[$DATE] Starting weekly Boot Environment creation..." >> $LOG_FILE

# Create Boot Environment with calendar week
YEAR=$(date '+%Y')
WEEK=$(date '+%U')
BE_NAME="${SNAPSHOT_PREFIX}-${YEAR}W$(printf '%02d' $WEEK)"

# Check if Boot Environment already exists
if bectl list -H | grep -q "^${BE_NAME}"; then
    echo "[$DATE] Boot Environment already exists: $BE_NAME" >> $LOG_FILE
else
    # Create Boot Environment
    echo "[$DATE] Creating Boot Environment: $BE_NAME" >> $LOG_FILE
    bectl create "$BE_NAME" 2>> $LOG_FILE
    if [ $? -eq 0 ]; then
        echo "[$DATE] Success: Boot Environment $BE_NAME created" >> $LOG_FILE
    else
        echo "[$DATE] Error creating Boot Environment: $BE_NAME" >> $LOG_FILE
    fi
fi

# Delete old Boot Environments (older than RETENTION_WEEKS)
CUTOFF_YEAR=$(date -j -v-${RETENTION_WEEKS}w '+%Y')
CUTOFF_WEEK=$(date -j -v-${RETENTION_WEEKS}w '+%U')
CUTOFF_YEARWEEK="${CUTOFF_YEAR}W$(printf '%02d' $CUTOFF_WEEK)"

echo "[$DATE] Cleaning up Boot Environments older than $RETENTION_WEEKS weeks (before $CUTOFF_YEARWEEK)..." >> $LOG_FILE

# List all Boot Environments and delete old ones
bectl list -H | grep "^${SNAPSHOT_PREFIX}-" | while read line; do
    be_name=$(echo "$line" | awk '{print $1}')
    be_yearweek=$(echo "$be_name" | sed "s/${SNAPSHOT_PREFIX}-//")
    
    # Check if BE is older than cutoff
    if [ "$be_yearweek" \< "$CUTOFF_YEARWEEK" ]; then
        # Check if BE is not active (no N or R flag)
        if ! echo "$line" | grep -q "[NR]"; then
            echo "[$DATE] Deleting old Boot Environment: $be_name" >> $LOG_FILE
            bectl destroy "$be_name" 2>> $LOG_FILE
            if [ $? -eq 0 ]; then
                echo "[$DATE] Successfully deleted: $be_name" >> $LOG_FILE
            else
                echo "[$DATE] Error deleting: $be_name" >> $LOG_FILE
            fi
        else
            echo "[$DATE] Skipping active Boot Environment: $be_name" >> $LOG_FILE
        fi
    fi
done

echo "[$DATE] Weekly Boot Environment process completed." >> $LOG_FILE
EOF

# -----------------------------------------------------------------------------
# 3. CONFIGD ACTIONS FILE: /usr/local/opnsense/service/conf/actions.d/actions_zfs_snapshot.conf
# -----------------------------------------------------------------------------
cat > /usr/local/opnsense/service/conf/actions.d/actions_zfs_snapshot.conf << 'EOF'
[daily_snapshot]
command:/root/zfs_daily_snapshot.sh
parameters:
type:script
description:ZFS Daily Boot Environment with 30-day retention
message:Creating daily ZFS Boot Environment with cleanup

[weekly_snapshot]
command:/root/zfs_weekly_snapshot.sh
parameters:
type:script
description:ZFS Weekly Boot Environment with 52-week retention
message:Creating weekly ZFS Boot Environment with cleanup

[list_snapshots]
command:/usr/sbin/bectl list
parameters:
type:script
description:List all ZFS Boot Environments
message:Listing ZFS Boot Environments
EOF

# -----------------------------------------------------------------------------
# 4. INSTALLATION AND SETUP
# -----------------------------------------------------------------------------

# Make script files executable
chmod +x /root/zfs_daily_snapshot.sh
chmod +x /root/zfs_weekly_snapshot.sh

# Create log directory
mkdir -p /var/log
touch /var/log/zfs_daily_snapshots.log
touch /var/log/zfs_weekly_snapshots.log

# Restart configd service to register new actions
service configd restart

echo "==============================================================================="
echo "ZFS Snapshot Scripts successfully installed!"
echo "==============================================================================="
echo ""
echo "Next steps in the OPNsense Web GUI:"
echo "1. Go to System > Settings > Cron"
echo "2. Click '+' to create new cron jobs"
echo ""
echo "DAILY SNAPSHOT:"
echo "- Command: ZFS Daily Boot Environment with 30-day retention"
echo "- Schedule: Daily at 11:00 PM (before weekly and updates)"
echo "- Minutes: 0, Hours: 23, Days: *, Months: *, Weekdays: *"
echo ""
echo "WEEKLY SNAPSHOT:"
echo "- Command: ZFS Weekly Boot Environment with 52-week retention" 
echo "- Schedule: Sundays at 10:00 PM"
echo "- Minutes: 0, Hours: 22, Days: *, Months: *, Weekdays: 0"
echo ""
echo "Log files:"
echo "- Daily: /var/log/zfs_daily_snapshots.log"
echo "- Weekly: /var/log/zfs_weekly_snapshots.log"
echo ""
echo "Test the scripts:"
echo "- /root/zfs_daily_snapshot.sh"
echo "- /root/zfs_weekly_snapshot.sh"
echo ""
echo "View snapshots:"
echo "- Command line: bectl list"
echo "- Web GUI: System > Snapshots"
echo "==============================================================================="