Skip to content

CHANGELOG.md

Latest commit

 

History

History
139 lines (105 loc) · 6.09 KB

CHANGELOG.md

File metadata and controls

139 lines (105 loc) · 6.09 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

[0.8.0] - 2026-05-20

Added

  • Skip-unchanged optimization (default on): the run command skips datasets whose live filesystem is byte-identical to a snapshot already captured by the previous backup. Uses native ZFS written property and snapshot creation time — no state, no extra IO. For pools of hundreds of mostly-dormant datasets this elides nearly all PBS calls.
  • Pre-flight clock-skew probe against the PBS HTTP Date: header. If skew exceeds the 60s safety margin (or the probe fails), the skip-unchanged optimization is disabled for that run and the tool falls back to schedule-only behavior. Never blocks the run.

Notes

  • --force continues to back up everything regardless of either check.
  • The skew check is one HTTPS HEAD per run; not user-configurable.

[0.6.0] - 2026-02-17

Added

  • Prometheus Pushgateway integration: push 6 metrics after each backup run (last run timestamp, last success timestamp, duration, successful/failed/skipped dataset counts)
  • ZPBS_PUSHGATEWAY environment variable: set to Pushgateway base URL to enable metrics; unset or empty disables (no-op)
  • State persistence at /var/lib/zpbs-backup/state.json: last_success_timestamp_seconds survives failed runs so the staleness alert reflects the true last success
  • ZPBS_PUSHGATEWAY added to diagnostic env-var display list

[0.5.2] - 2026-02-12

Fixed

  • status showing "683 months ago" or "never" for recently backed-up datasets — PBS list returns last-backup field, not backup-time; now checks both
  • Timestamp parsing handles missing, zero, or string (ISO 8601) values from PBS

Added

  • Automatically skip datasets with canmount=off or mounted=no (organizational/hierarchy-only datasets that hold no data)

[0.5.0] - 2026-02-09

Added

  • run --bg / run -b: trigger backup in background via systemd, returns immediately
  • POSIX short options for all commands: -n (dry-run), -f (force), -d (dataset), -j (json), -v (verbose), -b (background), -c (clear), -s (show-only), -o (orphans), -r (recursive)

[0.4.2] - 2026-02-09

Fixed

  • Use actual ZFS mountpoint instead of assuming /{dataset_name} — fixes backup failures for datasets whose mountpoint differs from their name
  • Skip datasets with mountpoint=none or mountpoint=legacy instead of failing

[0.4.1] - 2026-02-08

Changed

  • get command: argument order changed to get DATASET [PROPERTY] — property defaults to showing all
  • CLI hides zpbs: prefix from all user-facing output (use short names: backup, schedule, etc.)
  • Permission denied errors now suggest using sudo
  • Helpful hint on PBS privilege separation when connection check fails

[0.4.0] - 2026-02-08

Added

  • show-config command: display active PBS configuration, source, and connectivity check
    • --verbose flag shows all config sources in priority order
    • --json flag for machine-parseable output (suitable for automation)
  • send-test-notification command (replaces notify test)
  • New config variables aligned with PBS API token terminology:
    • PBS_API_TOKEN_SECRET (preferred over PBS_PASSWORD)
    • PBS_USER, PBS_API_TOKEN_NAME, PBS_SERVER, PBS_DATASTORE (individual parts)
  • Auto-composition of PBS_REPOSITORY from individual parts when not set explicitly
  • Config source tracking: shows which file or env var provided each setting
  • Per-user config file: ~/.config/zpbs-backup/pbs.conf
  • 40 new tests for config module

Changed

  • Config file search simplified to 2 locations: ~/.config/zpbs-backup/pbs.conf and /etc/zpbs-backup/pbs.conf
  • Removed legacy /root config file paths
  • notify test and notify config are now hidden deprecated aliases

Deprecated

  • notify test — use send-test-notification instead
  • notify config — use show-config instead

[0.3.2] - 2026-02-06

Added

  • Upfront PBS connectivity check in status, audit, and run commands
  • 30-second timeout on all PBS query commands (prevents indefinite hangs)

Fixed

  • Commands no longer hang when PBS server is unreachable

[0.3.1] - 2026-02-06

Fixed

  • Graceful handling when non-root user lacks permission to read config files
  • PBS namespace listing crash when API returns plain strings instead of objects

[0.3.0] - 2026-02-06

Added

  • Native .deb and .rpm package builds via nfpm
  • Makefile with make packages, make deb, make rpm targets
  • GitLab CI/CD pipeline for building and publishing system packages
  • GitLab Releases with downloadable .deb and .rpm assets
  • GitHub Releases with .deb and .rpm assets (via GitLab CI mirror)
  • Support for both amd64 and arm64 architectures

Changed

  • Version is now derived from __init__.py as single source of truth (pyproject.toml uses dynamic versioning via hatchling)

[0.2.0] - 2026-02-02

Added

  • Syslog support for centralized logging
  • Email notification system with notify command group
    • zpbs-backup notify test - Test notification configuration
    • zpbs-backup notify config - Show notification settings
  • Shell variable interpolation in PBS configuration files
  • Hierarchical namespace creation (auto-creates parent namespaces)
  • --no-notify flag for run command

Changed

  • Configuration files now support variable interpolation (e.g., ${PBS_USER})
  • Improved error handling and logging throughout

[0.1.0] - Initial Release

Added

  • Initial implementation of zpbs-backup
  • Auto-discovery of ZFS datasets via custom properties
  • Property inheritance through dataset hierarchy
  • Schedule-aware backups (daily/weekly/monthly)
  • Priority-based backup ordering
  • Retention policy management
  • Dry-run mode for all operations
  • Audit mode for orphaned backups and missed datasets
  • CLI commands: status, run, audit, prune, get, set, inherit
  • Systemd service and timer units
  • Configuration via environment variables or config files
  • PBS namespace support with auto-derivation