From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <f.ebner@proxmox.com> Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id CEEEE922A2 for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:20 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 74A5132337 for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:20 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:17 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 988CB44753 for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:15 +0200 (CEST) From: Fiona Ebner <f.ebner@proxmox.com> To: pve-devel@lists.proxmox.com Date: Mon, 3 Oct 2022 15:52:09 +0200 Message-Id: <20221003135211.183340-7-f.ebner@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221003135211.183340-1-f.ebner@proxmox.com> References: <20221003135211.183340-1-f.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.029 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH docs 2/4] backup: expand section for jobs X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com> List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe> List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/> List-Post: <mailto:pve-devel@lists.proxmox.com> List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help> List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe> X-List-Received-Date: Mon, 03 Oct 2022 13:52:20 -0000 Signed-off-by: Fiona Ebner <f.ebner@proxmox.com> --- vzdump.adoc | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/vzdump.adoc b/vzdump.adoc index 0c5b32e..01e1c20 100644 --- a/vzdump.adoc +++ b/vzdump.adoc @@ -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 +endpoint. + +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. [[vzdump_retention]] Backup Retention -- 2.30.2