[PATCH backup] maintenance: Document supported maintenance modes

[PATCH backup] maintenance: Document supported maintenance modes

[Maximiliano Sandoval]

Strings taken from MaintenanceType at pbs-api-types.

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---

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

applied: [PATCH backup] maintenance: Document supported maintenance modes

[Thomas Lamprecht]

On Thu, 19 Feb 2026 16:11:10 +0100, Maximiliano Sandoval wrote:
> Strings taken from MaintenanceType at pbs-api-types.
> 
> 

Applied, thanks!

[1/1] maintenance: Document supported maintenance modes
      commit: 351007e28ac3b776c479097d1478c3656b1073e7

Re: [PATCH backup] maintenance: Document supported maintenance modes

[Christian Ebner]

On 2/19/26 4:11 PM, Maximiliano Sandoval wrote:
> Strings taken from MaintenanceType at pbs-api-types.
> 

Thanks for improving the docs!

One question came up: Should we list and describe the other maintenance 
mode variants as well? They are user facing after all (e.g. in the 
datastore summary while mounting/unmounting, s3 refresh).

Maybe they could be listed in a table instead and explicitly mentioned 
which modes can be explicitly set by the user and which modes are only 
set implicitly via e.g. a removable datastore mount operation.