From da50ecc60e80ddc7d55299a0bf8c4b25b3544674 Mon Sep 17 00:00:00 2001 From: Olivier Date: Wed, 13 May 2026 17:07:38 +0200 Subject: [PATCH] Refresh README feature overview --- README.fr.md | 12 ++++++++++-- README.md | 12 ++++++++++-- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.fr.md b/README.fr.md index 8ba5112..54788d1 100644 --- a/README.fr.md +++ b/README.fr.md @@ -16,8 +16,11 @@ Outil Python pour générer un rapport quotidien des sauvegardes Proxmox VE vers - 📄 Rapport PDF quotidien horodaté, sans écrasement des rapports précédents. - 🧭 Inventaire des stockages PBS déclarés dans Proxmox VE. - ✅ Analyse de couverture des VM QEMU et conteneurs LXC. -- 🕒 Récupération des dernières sauvegardes connues via les tâches PVE. -- 🗄️ Collecte optionnelle des datastores, namespaces, prune jobs et snapshots PBS. +- 📝 Notes PVE des VM/CT intégrées au rapport. +- 🕒 Récupération des dernières sauvegardes connues via les tâches PVE et les logs `vzdump`. +- 🗄️ Collecte optionnelle des datastores, namespaces, prune jobs, snapshots et espaces PBS. +- 🔐 Audit des utilisateurs PBS et permissions effectives associées aux stockages PVE. +- 📊 Rétention PBS avec nombre attendu de versions, delta et état PVE des VM/CT. - ⚠️ Section d'anomalies pour les erreurs ou données de collecte partielles. - 🐳 Exécution recommandée avec Docker, ou exécution directe en CLI. @@ -105,6 +108,7 @@ docker compose run --rm pve-backup-report --dump-inventory docker compose run --rm pve-backup-report --dump-coverage docker compose run --rm pve-backup-report --dump-report-data docker compose run --rm pve-backup-report --dump-pbs-storage-usages +docker compose run --rm pve-backup-report --dump-pbs-users docker compose run --rm pve-backup-report --debug-last-backup-vmid ``` @@ -153,7 +157,9 @@ pve-backup-report --dump-inventory pve-backup-report --dump-coverage pve-backup-report --dump-report-data pve-backup-report --dump-pbs-storage-usages +pve-backup-report --dump-pbs-users pve-backup-report --generate-pdf +pve-backup-report --debug-last-backup-vmid ``` Sans installation éditable, depuis le dépôt : @@ -165,7 +171,9 @@ PYTHONPATH=src python3 -m pve_backup_report --dump-inventory PYTHONPATH=src python3 -m pve_backup_report --dump-coverage PYTHONPATH=src python3 -m pve_backup_report --dump-report-data PYTHONPATH=src python3 -m pve_backup_report --dump-pbs-storage-usages +PYTHONPATH=src python3 -m pve_backup_report --dump-pbs-users PYTHONPATH=src python3 -m pve_backup_report --generate-pdf +PYTHONPATH=src python3 -m pve_backup_report --debug-last-backup-vmid ``` En exécution locale directe, `REPORT_OUTPUT_DIR` peut rester à `reports/` ou pointer vers un autre répertoire accessible par l'utilisateur courant. diff --git a/README.md b/README.md index 4d5d576..c96e3b4 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,11 @@ Python tool to generate a daily backup report for Proxmox VE against Proxmox Bac - 📄 Timestamped daily PDF report, without overwriting previous reports. - 🧭 Inventory of PBS storages declared in Proxmox VE. - ✅ Coverage analysis for QEMU VMs and LXC containers. -- 🕒 Retrieval of the latest known backups via PVE tasks. -- 🗄️ Optional collection of PBS datastores, namespaces, prune jobs and snapshots. +- 📝 PVE VM/CT notes included in the report. +- 🕒 Retrieval of the latest known backups via PVE tasks and `vzdump` logs. +- 🗄️ Optional collection of PBS datastores, namespaces, prune jobs, snapshots and storage usage. +- 🔐 Audit of PBS users and effective permissions associated with PVE storages. +- 📊 PBS retention with expected version counts, delta and PVE state for VM/CT entries. - ⚠️ Anomalies section for errors or partial collection data. - 🐳 Recommended execution with Docker, or direct CLI execution. @@ -102,6 +105,7 @@ docker compose run --rm pve-backup-report --dump-inventory docker compose run --rm pve-backup-report --dump-coverage docker compose run --rm pve-backup-report --dump-report-data docker compose run --rm pve-backup-report --dump-pbs-storage-usages +docker compose run --rm pve-backup-report --dump-pbs-users docker compose run --rm pve-backup-report --debug-last-backup-vmid ``` @@ -150,7 +154,9 @@ pve-backup-report --dump-inventory pve-backup-report --dump-coverage pve-backup-report --dump-report-data pve-backup-report --dump-pbs-storage-usages +pve-backup-report --dump-pbs-users pve-backup-report --generate-pdf +pve-backup-report --debug-last-backup-vmid ``` Without an editable install, from the repository: @@ -162,7 +168,9 @@ PYTHONPATH=src python3 -m pve_backup_report --dump-inventory PYTHONPATH=src python3 -m pve_backup_report --dump-coverage PYTHONPATH=src python3 -m pve_backup_report --dump-report-data PYTHONPATH=src python3 -m pve_backup_report --dump-pbs-storage-usages +PYTHONPATH=src python3 -m pve_backup_report --dump-pbs-users PYTHONPATH=src python3 -m pve_backup_report --generate-pdf +PYTHONPATH=src python3 -m pve_backup_report --debug-last-backup-vmid ``` In direct local execution, `REPORT_OUTPUT_DIR` can remain `reports/` or point to any other directory writable by the current user.