From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 707F21FF135 for ; Thu, 02 Jul 2026 17:01:13 +0200 (CEST) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id D7448214CF; Thu, 02 Jul 2026 17:01:12 +0200 (CEST) From: Robert Obkircher To: pbs-devel@lists.proxmox.com Subject: [PATCH proxmox-backup v2 13/13] docs: document garbage-collection maintenance mode Date: Thu, 2 Jul 2026 16:59:10 +0200 Message-ID: <20260702145916.360488-14-r.obkircher@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260702145916.360488-1-r.obkircher@proxmox.com> References: <20260702145916.360488-1-r.obkircher@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1783004432936 X-SPAM-LEVEL: Spam detection results: 0 DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Message-ID-Hash: 35SRSW3N6QKOTANF2IUHMT3UDVVEDUIE X-Message-ID-Hash: 35SRSW3N6QKOTANF2IUHMT3UDVVEDUIE X-MailFrom: r.obkircher@proxmox.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; loop; banned-address; emergency; member-moderation; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.10 Precedence: list List-Id: Proxmox Backup Server development discussion List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Signed-off-by: Robert Obkircher --- docs/maintenance.rst | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 46d9502d9..3459c097d 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -338,8 +338,8 @@ Refer to the :ref:`notifications` chapter for more details. Maintenance Mode ---------------- -Proxmox Backup Server supports setting `read-only` and `offline` -maintenance modes on a datastore. +Proxmox Backup Server supports setting `read-only`, `garbage-collection`, and +`offline` maintenance modes on a datastore. Once enabled, depending on the mode, new reads and/or writes to the datastore are blocked, allowing an administrator to safely execute maintenance tasks, for @@ -354,4 +354,13 @@ The supported maintenance modes are: - ``read-only``: Only read operations are allowed on the datastore. +- ``garbage-collection``: Read operations and GC-related writes are allowed. + - ``offline``: Neither read nor write operations are allowed on the datastore. + +The `garbage-collection` mode is designed to safely reclaim storage space when +a datastore is nearly full. It allows prune jobs, garbage-collection, and +snapshot deletions. Other writes, such as new backups, are blocked, so they +cannot consume the remaining space. This is crucial for copy-on-write file +systems like ZFS, where garbage-collection needs some additional space for +metadata updates. -- 2.47.3