danvics/ProxmoxBackupClientPBSClientTool
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ProxmoxBackupClientPBSClien.../CHANGELOG.md
zaphod-black fc78ff9ddb WIP: Multi-target backup support (Part 2 of 3) - 90% Complete 
This commit completes the core infrastructure for multi-target backups.
Only main menu integration remains.

COMPLETED IN THIS COMMIT:

1. Per-target wrapper functions:
   - interactive_config_for_target(name) - Full configuration wizard
   - reconfigure_connection_for_target(name) - Connection-only updates
   - reconfigure_backup_settings_for_target(name) - Settings-only updates
   - run_backup_for_target(name) - Execute backup with live progress

2. Systemd service creation for named targets:
   - create_systemd_service_for_target(name) - Complete service generation
   - Generates pbs-backup-TARGET.service (scheduled backups)
   - Generates pbs-backup-TARGET-manual.service (manual full backups)
   - Generates pbs-backup-TARGET.timer (scheduler)
   - Creates target-specific backup scripts with embedded target name
   - All configs stored in /etc/proxmox-backup-client/targets/TARGET.conf

3. Main menu partially updated:
   - Added migrate_legacy_config() call at startup
   - Started new multi-target menu structure
   - Menu shows: List, Add, Edit, Delete, Run, View, Reinstall, Exit

FEATURES:
- Each target = independent systemd services
- Target-specific backup scripts include target name in logs
- Live progress monitoring per target
- Complete isolation between targets
- Backward compatible via automatic migration

TESTING STATUS:
- Syntax validated (no errors)
- Not yet functionally tested
- Migration logic not tested
- Menu integration incomplete

REMAINING WORK (Part 3):
- Complete main menu case statement updates
- Add first-time setup flow for new installations
- Add "Run all targets" bulk backup option
- Test legacy→multi-target migration
- Full integration testing
- Update README with multi-target examples

CHANGELOG UPDATED:
- Detailed breakdown of completed components
- Clear TODO list for remaining work
- Marked as "90% Complete"

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-01 20:41:44 -05:00

7.7 KiB
Raw Blame History

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]

Added

  • Multi-target backup support (v1.1.0 - 90% Complete)
    • Support for multiple backup destinations (different PBS servers for redundancy)
    • Named backup targets (e.g., "offsite", "local", "backup1")
    • Target management functions (COMPLETE):
      • list_targets() - List all configured target names
      • show_targets_list() - Display all targets with server/datastore/status
      • show_target_detail() - Show comprehensive target configuration
      • add_target() - Interactive target creation wizard
      • edit_target() - Edit connection, settings, or full reconfig
      • delete_target() - Remove target with confirmation and cleanup
      • validate_target_name() - Enforce naming rules (alphanumeric, dash, underscore)
    • Per-target wrapper functions (COMPLETE):
      • interactive_config_for_target() - Configure specific target
      • reconfigure_connection_for_target() - Update connection only
      • reconfigure_backup_settings_for_target() - Update backup settings only
      • run_backup_for_target() - Execute backup with live progress monitoring
    • Systemd service creation (COMPLETE):
      • create_systemd_service_for_target() - Generate all services for named target
      • Creates pbs-backup-TARGET.service (scheduled)
      • Creates pbs-backup-TARGET-manual.service (manual/full)
      • Creates pbs-backup-TARGET.timer (scheduler)
      • Generates target-specific backup scripts with embedded target name
    • Automatic migration (COMPLETE):
      • migrate_legacy_config() - Auto-migrate single-target to "default" target
      • Renames services: pbs-backup → pbs-backup-default
      • Preserves existing schedules and backups
      • Zero downtime migration
    • Configuration storage (COMPLETE):
      • /etc/proxmox-backup-client/targets/TARGET.conf
      • /etc/proxmox-backup-client/backup-TARGET.sh
      • /etc/systemd/system/pbs-backup-TARGET.{service,timer}
    • TODO (Main menu integration):
      • Update main menu to show multi-target options
      • Handle first-time setup for new installations
      • Add "Run all targets" option
      • Test migration from legacy to multi-target
  • Intelligent reconfiguration options when PBS client is already installed
    • Quick connection-only reconfiguration (server/credentials only)
    • Full reconfiguration of all settings
    • Reinstall option with reconfiguration
    • Exit without changes option
  • 3-step connection verification process:
    • Step 1: Server reachability test (5s timeout with curl)
    • Step 2: Authentication test with automatic SSL fingerprint acceptance
    • Step 3: Datastore access verification
  • Display available block devices when invalid device is entered
  • Step-by-step progress indicators during connection testing
  • test-connection.sh - Diagnostic script for testing PBS connections manually
    • Parameterized for security (no hardcoded credentials)
    • Tests server reachability, authentication, and datastore access
    • Handles SSL fingerprint acceptance interactively
  • Comprehensive documentation in README:
    • Step-by-step walkthrough of complete installation (14 steps)
    • PBS server setup guide (API token creation and permissions)
    • Common permission error troubleshooting
    • Explanation of backup types, schedules, and retention policies
  • Live backup progress monitoring
    • Real-time log following when running backups
    • Automatic completion detection
    • Shows PBS client's built-in progress bars and statistics
    • Can exit with Ctrl+C (backup continues in background)
    • Applied to both "Run backup now" menu option and post-install backup

Changed

  • Installation instructions now use git clone instead of wget
  • Connection test provides better user feedback during testing
  • Script now detects existing configurations and offers appropriate options
  • Block device detection now strips btrfs subvolume notation (e.g., [/@])
  • Connection test succeeds if authentication works, even if no backups exist yet
  • More specific error messages based on which step of connection test fails
  • SSL certificate fingerprints are now automatically accepted during setup
  • Reduced authentication timeout from 30s to 15s
  • README now includes comprehensive step-by-step walkthrough
  • Prerequisites section expanded with detailed PBS server setup instructions
  • README updated with live backup progress examples in Step 13
  • Reconfiguration section now documents "Run backup now" option (option 4)
  • Manual Backup section updated to recommend easy method via installer
  • Default realm changed from "pbs" to "pam" (more common for root authentication)
  • Default encryption setting changed from "yes" to "no" (user can opt-in if needed)
  • Main menu now includes "Run backup now" option for immediate backup testing
  • Main menu now includes "Modify backup schedule/type" option (option 5)
  • Repository renamed from PBSClientInstaller to PBSClientTool
  • Manual backups now force full backup (files + block device) regardless of day
    • Created separate pbs-backup-manual.service for manual runs
    • Scheduled backups still follow daily/weekly pattern
    • Manual backups always include block device even on non-Sunday
  • Script version bumped to 1.1.0 for multi-target support

Fixed

  • CRITICAL: SSL fingerprint prompt no longer causes authentication timeout
    • Script now automatically accepts SSL fingerprints by piping 'y' to login
    • This was the root cause of "authentication hanging" issues
  • CRITICAL: Password/token capture no longer includes newline character
    • prompt_password() function now outputs formatting to stderr
    • Added defensive newline stripping when writing config file
    • Filters \n and \r characters from passwords using tr -d '\n\r'
    • Fixes "authentication failed - invalid credentials" in backup service
    • Config file now has properly formatted single-line passwords
    • Applied to both reconfigure_connection() and create_systemd_service()
  • Script no longer hangs indefinitely when PBS server is unreachable
  • Block device auto-detection now correctly handles btrfs subvolumes
  • Invalid device paths like /dev/mapper/root[/@] are now properly cleaned
  • Connection test now differentiates between network issues and authentication failures
  • Shows actual PBS client error messages when authentication fails
  • Authentication test now uses correct login command instead of non-existent status command
  • Connection test no longer times out due to using wrong PBS client commands
  • Backup progress logs now display properly during manual backup runs
    • Fixed journalctl following wrong service (was following pbs-backup.service instead of pbs-backup-manual.service)
    • Removed stderr suppression (2>/dev/null) that was hiding output
    • Added --since flag to capture logs from service start, not just new entries
    • Now shows verbose progress: "processed 65.6 GiB in 18m, uploaded 64.4 GiB"
  • Backup logs now close automatically when backup completes (no more blank screen)

[1.0.0] - 2025-11-01

Added

  • Initial release
  • Auto-detection of Linux distribution (Ubuntu, Debian, Arch)
  • Interactive configuration via console prompts
  • Automatic encryption key generation with paper backup
  • Systemd service and timer for automated backups
  • Configurable retention policies
  • Connection testing before finalization
  • Immediate backup option after installation
  • Support for file-level (.pxar) backups
  • Support for block device (.img) backups
  • Hybrid backup mode (daily files + weekly block device)
  • Comprehensive error handling and logging
  • Uninstaller script