From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 9E4A91FF13C for ; Thu, 19 Feb 2026 16:10:44 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id D0DE61AE47; Thu, 19 Feb 2026 16:11:44 +0100 (CET) From: Maximiliano Sandoval To: pbs-devel@lists.proxmox.com Subject: [PATCH backup] maintenance: Document supported maintenance modes Date: Thu, 19 Feb 2026 16:11:10 +0100 Message-ID: <20260219151111.508869-1-m.sandoval@proxmox.com> X-Mailer: git-send-email 2.47.3 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1771513862164 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.087 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_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 Message-ID-Hash: NXZZHGN3FZBM6EH663JGIEBOGI2GSNL6 X-Message-ID-Hash: NXZZHGN3FZBM6EH663JGIEBOGI2GSNL6 X-MailFrom: m.sandoval@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: Strings taken from MaintenanceType at pbs-api-types. Signed-off-by: Maximiliano Sandoval --- Personally, I find `read-only` almost-but-not-quite self-explanatory, offline on the other hand benefits from an explicit explanation. docs/maintenance.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 051a7f4e8..46d9502d9 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -349,3 +349,9 @@ Internally Proxmox Backup Server tracks whether each datastore access is a write or read operation, so that it can gracefully enter the respective mode, by allowing conflicting operations that started before enabling the maintenance mode to finish. + +The supported maintenance modes are: + +- ``read-only``: Only read operations are allowed on the datastore. + +- ``offline``: Neither read nor write operations are allowed on the datastore. -- 2.47.3