olivier/PVE-Backup-Report
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Refresh README feature overview

Browse Source
This commit is contained in:
Olivier
2026-05-13 17:07:38 +02:00
parent 8331b7ad7d
commit da50ecc60e
2 changed files with 20 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.fr.md
+10 -2
View File
@@ -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. - 📄 Rapport PDF quotidien horodaté, sans écrasement des rapports précédents.
- 🧭 Inventaire des stockages PBS déclarés dans Proxmox VE. - 🧭 Inventaire des stockages PBS déclarés dans Proxmox VE.
- ✅ Analyse de couverture des VM QEMU et conteneurs LXC. - ✅ Analyse de couverture des VM QEMU et conteneurs LXC.
- 🕒 Récupération des dernières sauvegardes connues via les tâches PVE. - 📝 Notes PVE des VM/CT intégrées au rapport.
- 🗄️ Collecte optionnelle des datastores, namespaces, prune jobs et snapshots PBS. - 🕒 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. - ⚠️ Section d'anomalies pour les erreurs ou données de collecte partielles.
- 🐳 Exécution recommandée avec Docker, ou exécution directe en CLI. - 🐳 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-coverage
docker compose run --rm pve-backup-report --dump-report-data 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-storage-usages
docker compose run --rm pve-backup-report --dump-pbs-users
docker compose run --rm pve-backup-report --debug-last-backup-vmid <VMID> docker compose run --rm pve-backup-report --debug-last-backup-vmid <VMID>
``` ```
@@ -153,7 +157,9 @@ pve-backup-report --dump-inventory
pve-backup-report --dump-coverage pve-backup-report --dump-coverage
pve-backup-report --dump-report-data pve-backup-report --dump-report-data
pve-backup-report --dump-pbs-storage-usages pve-backup-report --dump-pbs-storage-usages
pve-backup-report --dump-pbs-users
pve-backup-report --generate-pdf pve-backup-report --generate-pdf
pve-backup-report --debug-last-backup-vmid <VMID>
``` ```
Sans installation éditable, depuis le dépôt : 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-coverage
PYTHONPATH=src python3 -m pve_backup_report --dump-report-data 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-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 --generate-pdf
PYTHONPATH=src python3 -m pve_backup_report --debug-last-backup-vmid <VMID>
``` ```
En exécution locale directe, `REPORT_OUTPUT_DIR` peut rester à `reports/` ou pointer vers un autre répertoire accessible par l'utilisateur courant. En exécution locale directe, `REPORT_OUTPUT_DIR` peut rester à `reports/` ou pointer vers un autre répertoire accessible par l'utilisateur courant.
README.md
+10 -2
View File
@@ -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. - 📄 Timestamped daily PDF report, without overwriting previous reports.
- 🧭 Inventory of PBS storages declared in Proxmox VE. - 🧭 Inventory of PBS storages declared in Proxmox VE.
- ✅ Coverage analysis for QEMU VMs and LXC containers. - ✅ Coverage analysis for QEMU VMs and LXC containers.
- 🕒 Retrieval of the latest known backups via PVE tasks. - 📝 PVE VM/CT notes included in the report.
- 🗄️ Optional collection of PBS datastores, namespaces, prune jobs and snapshots. - 🕒 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. - ⚠️ Anomalies section for errors or partial collection data.
- 🐳 Recommended execution with Docker, or direct CLI execution. - 🐳 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-coverage
docker compose run --rm pve-backup-report --dump-report-data 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-storage-usages
docker compose run --rm pve-backup-report --dump-pbs-users
docker compose run --rm pve-backup-report --debug-last-backup-vmid <VMID> docker compose run --rm pve-backup-report --debug-last-backup-vmid <VMID>
``` ```
@@ -150,7 +154,9 @@ pve-backup-report --dump-inventory
pve-backup-report --dump-coverage pve-backup-report --dump-coverage
pve-backup-report --dump-report-data pve-backup-report --dump-report-data
pve-backup-report --dump-pbs-storage-usages pve-backup-report --dump-pbs-storage-usages
pve-backup-report --dump-pbs-users
pve-backup-report --generate-pdf pve-backup-report --generate-pdf
pve-backup-report --debug-last-backup-vmid <VMID>
``` ```
Without an editable install, from the repository: 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-coverage
PYTHONPATH=src python3 -m pve_backup_report --dump-report-data 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-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 --generate-pdf
PYTHONPATH=src python3 -m pve_backup_report --debug-last-backup-vmid <VMID>
``` ```
In direct local execution, `REPORT_OUTPUT_DIR` can remain `reports/` or point to any other directory writable by the current user. In direct local execution, `REPORT_OUTPUT_DIR` can remain `reports/` or point to any other directory writable by the current user.