From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
	by lore.proxmox.com (Postfix) with ESMTPS id 318C21FF385
	for <inbox@lore.proxmox.com>; Wed, 26 Jun 2024 10:13:48 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 1061A1B901;
	Wed, 26 Jun 2024 10:13:57 +0200 (CEST)
From: Christian Ebner <c.ebner@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Wed, 26 Jun 2024 10:13:11 +0200
Message-Id: <20240626081311.45882-1-c.ebner@proxmox.com>
X-Mailer: git-send-email 2.39.2
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.379 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible
 spam tricks
 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 pve-docs] vzdump: add section describing PBS
 change detection mode
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>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>

Add a concise section about what PBS change detection mode is and
what it affects, including a table with a description of the modes.

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 vzdump.adoc | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/vzdump.adoc b/vzdump.adoc
index 79d4bbc..958ee12 100644
--- a/vzdump.adoc
+++ b/vzdump.adoc
@@ -171,6 +171,30 @@ fleecing image up-front. On a thinly provisioned storage, the fleecing image can
 grow to the same size as the original image only if the guest re-writes a whole
 disk while the backup is busy with another disk.
 
+CT Change Detection Mode
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Setting the change detection mode defines the encoding format for the pxar
+archives and how changed and unchanged files are handled for container backups
+with Proxmox Backup Server as target.
+
+Backups of VMs or to other storage backends are not affected by this setting.
+
+There are 3 change detection modes available:
+
+[width="100%",cols="<m,4d",options="header"]
+|===============================================================================
+| Mode     | Description
+| Default  | The legacy mode, read and encode all files in a self contained
+pxar archive with format version 1 being uploaded to the Proxmox Backup Server.
+| Data     | (EXPERIMENTAL): Read and encode all files, but split data and
+metadata into separate streams, using the pxar format version 2.
+| Metadata | (EXPERIMENTAL): Use the metadata archive of the previous backup
+run to detect unchanged files and reuse the files data already backed up in the
+previous backup for the current backup run when possible. Data and metadata are
+encoded into separate streams, using the pxar format version 2.
+|===============================================================================
+
 Backup File Names
 -----------------
 
-- 
2.39.2



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel