From 67d41311584d8ff890fd84055a63455e06f6d781 Mon Sep 17 00:00:00 2001 From: Thomas Lamprecht Date: Tue, 17 May 2022 13:28:24 +0200 Subject: [PATCH] docs: basic maintenance mode section Signed-off-by: Thomas Lamprecht --- docs/maintenance.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/maintenance.rst b/docs/maintenance.rst index 71016a62..7ca4a7ac 100644 --- a/docs/maintenance.rst +++ b/docs/maintenance.rst @@ -186,3 +186,20 @@ following options are available: * Errors: send a notification for any scheduled task that results in an error * Never: do not send any notification at all + +.. _maintenance_mode: + +Maintenance Mode +---------------- + +Proxmox Backup Server implements setting the `read-only` and `offline` +maintenance modes for 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 +example, on the underlying storage. + +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.