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 37AE192310 for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:51 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1027532342 for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:21 +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:18 +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 0AFAF44612 for <pve-devel@lists.proxmox.com>; Mon, 3 Oct 2022 15:52:16 +0200 (CEST) From: Fiona Ebner <f.ebner@proxmox.com> To: pve-devel@lists.proxmox.com Date: Mon, 3 Oct 2022 15:52:10 +0200 Message-Id: <20221003135211.183340-8-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 3/4] backup: merge sections describing 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:51 -0000 keeping a short intro referring to the full section at the beginning. Signed-off-by: Fiona Ebner <f.ebner@proxmox.com> --- vzdump.adoc | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/vzdump.adoc b/vzdump.adoc index 01e1c20..841cf3d 100644 --- a/vzdump.adoc +++ b/vzdump.adoc @@ -48,19 +48,9 @@ drive, for off-site archiving. .Scheduled Backup -Backup jobs can be scheduled so that they are executed automatically -on specific days and times, for selectable nodes and guest systems. -Configuration of scheduled backups is done at the Datacenter level in -the GUI, which will generate a job entry in /etc/pve/jobs.cfg, which -will in turn be parsed and executed by the `pvescheduler` daemon. -These jobs use the xref:chapter_calendar_events[calendar events] for -defining the schedule. - -Since scheduled backups miss their execution when the host was offline or the -pvescheduler was disabled during the scheduled time, it is possible to configure -the behaviour for catching up. By enabling the `Repeat missed` option -(`repeat-missed` in the config), you can tell the scheduler that it should run -missed jobs as soon as possible. +Backup jobs can be scheduled so that they are executed automatically on specific +days and times, for selectable nodes and guest systems. See the +xref:vzdump_jobs[Backup Jobs] section for more. Backup Modes ------------ @@ -196,13 +186,15 @@ Backup Encryption For Proxmox Backup Server storages, you can optionally set up client-side encryption of backups, see xref:storage_pbs_encryption[the corresponding section.] +[[vzdump_jobs]] 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. You can manage the jobs in the UI under 'Datacenter' -> 'Backup' or via the `/cluster/backup` API -endpoint. +endpoint. Both will generate job entries in `/etc/pve/jobs.cfg`, which are +parsed and executed by the `pvescheduler` daemon. 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 @@ -216,6 +208,12 @@ 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. +Since scheduled backups miss their execution when the host was offline or the +pvescheduler was disabled during the scheduled time, it is possible to configure +the behaviour for catching up. By enabling the `Repeat missed` option +(`repeat-missed` in the config), you can tell the scheduler that it should run +missed jobs as soon as possible. + 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`), -- 2.30.2