public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Robert Obkircher <r.obkircher@proxmox.com>
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	[thread overview]
Message-ID: <20260702145916.360488-14-r.obkircher@proxmox.com> (raw)
In-Reply-To: <20260702145916.360488-1-r.obkircher@proxmox.com>

Signed-off-by: Robert Obkircher <r.obkircher@proxmox.com>
---
 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





      parent reply	other threads:[~2026-07-02 15:01 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-07-02 14:58 [PATCH proxmox{,-backup} v2 00/13] add GarbageCollection maintenance mode Robert Obkircher
2026-07-02 14:58 ` [PATCH proxmox v2 01/13] pbs-api-types: propagate maintenance mode parse errors Robert Obkircher
2026-07-02 14:58 ` [PATCH proxmox v2 02/13] pbs-api-types: use match statement for maintenance mode check Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox v2 03/13] pbs-api-types: deny non-lookup operations for unknown modes Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox v2 04/13] pbs-api-types: add WriteNonExpanding datastore operation Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox v2 05/13] pbs-api-types: add GarbageCollection maintenance mode Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 06/13] datastore: propagate maintenance mode parse errors Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 07/13] task tracking: only read starttime when needed Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 08/13] task tracking: use parameter for initial count and refactor updates Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 09/13] www: access active operation fields by name instead of index Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 10/13] task tracking: count WriteNonExpanding datastore operations Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 11/13] datastore: open datastores with WriteNonExpanding instead of Write Robert Obkircher
2026-07-02 14:59 ` [PATCH proxmox-backup v2 12/13] fix #5797: www: display new GarbageCollection maintenance mode Robert Obkircher
2026-07-02 14:59 ` Robert Obkircher [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260702145916.360488-14-r.obkircher@proxmox.com \
    --to=r.obkircher@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal