[pve-devel] [PATCH docs 2/4] backup: expand section for jobs
f.ebner at proxmox.com
Mon Oct 3 15:52:09 CEST 2022
Signed-off-by: Fiona Ebner <f.ebner at proxmox.com>
vzdump.adoc | 24 +++++++++++++++++++++---
1 file changed, 21 insertions(+), 3 deletions(-)
diff --git a/vzdump.adoc b/vzdump.adoc
index 0c5b32e..01e1c20 100644
@@ -200,9 +200,27 @@ Backup Jobs
Besides triggering a backup manually, you can also setup periodic jobs that
-backup all, or a selection of virtual guest to a storage.
-// TODO: extend, link to retention below, ... di & document perf max-worker settings
+backup all, or a selection of virtual guest to a storage. You can manage the
+jobs in the UI under 'Datacenter' -> 'Backup' or via the `/cluster/backup` API
+A job is either configured for all cluster nodes or a specific node, and is
+executed according to a given schedule. The format for the schedule is very
+similar to `systemd` calendar events, see the
+xref:chapter_calendar_events[calendar events] section for details. The
+'Schedule' field in the UI can be freely edited, and it contains several
+examples that can be used as a starting point in its drop-down list.
+You can configure job-specific xref:vzdump_retention[retention options]
+overriding those from the storage or node configuration, as well as a
+xref:vzdump_notes[template for notes] for additional information to be saved
+together with the backup.
+There are a few settings for tuning backup performance not exposed in the UI.
+The most notable is `bwlimit` for limiting IO bandwidth. The amount of threads
+used for the compressor can be controlled with the `pigz` (replacing `gzip`),
+respectively, `zstd` setting. Furthermore, there is `ionice`. See the
+xref:vzdump_configuration[configuration options] for details.
More information about the pve-devel