From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [PATCH proxmox-backup v2 42/43] docs: describe the privileges and roles for append only backup/sync
Date: Fri, 6 Nov 2026 18:22:34 +0100 [thread overview]
Message-ID: <20261106172235.890542-43-c.ebner@proxmox.com> (raw)
In-Reply-To: <20261106172235.890542-1-c.ebner@proxmox.com>
Complete the list with the newly added roles and permissions and
mention their intended usecase.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
docs/managing-remotes.rst | 6 +++++-
docs/user-management.rst | 16 ++++++++++++++++
2 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst
index 9f269b56b..b25e3d532 100644
--- a/docs/managing-remotes.rst
+++ b/docs/managing-remotes.rst
@@ -109,7 +109,11 @@ To set up sync jobs, the configuring user needs the following permissions:
job, ``Datastore.Modify`` or ``Datastore.Read`` is required on the source
datastore. Otherwise, ``Datastore.Backup`` is enough to configure a sync job
limited to owned backup groups.
-* At least ``Datastore.Backup`` on the local target datastore (``/datastore/{store}``)
+* At least ``Datastore.Backup`` or ``Datastore.Append`` on the local target
+ datastore (``/datastore/{store}``). Using ``Datastore.Append`` enables
+ append-only sync jobs that can push or pull new snapshots and create
+ sub-namespaces, but lack permissions to read, restore, modify, or prune
+ existing backups.
.. note:: A sync job can only sync backup groups that the configured remote's
user/API token can read. If a remote is configured with a user/API token that
diff --git a/docs/user-management.rst b/docs/user-management.rst
index 066027edd..560009d3e 100644
--- a/docs/user-management.rst
+++ b/docs/user-management.rst
@@ -219,6 +219,11 @@ We currently support the following privileges:
privileges of Datastore.Read and Datastore.Verify, but only if the backup
group is owned by the user or one of its tokens.
+**Datastore.Append**
+ Datastore.Append allows a user or API token to append new backup snapshots and
+ create new namespaces, without granting privileges to read, restore, modify,
+ or prune existing backups.
+
**Datastore.Prune**
Datastore.Prune allows a user to delete snapshots, but additionally requires
backup ownership.
@@ -238,6 +243,10 @@ We currently support the following privileges:
**Remote.Read**
Remote.Read allows a user to read data from a configured `Remote`.
+**Remote.DatastoreAppend**
+ Remote.DatastoreAppend allows pushing backups to a remote datastore using
+ append-only privileges.
+
**Sys.Console**
Sys.Console allows a user to access the system's console, note that for all
but `root@pam` a valid system login is still required.
@@ -295,6 +304,10 @@ The following roles exist:
**DatastoreBackup**
Can backup and restore owned backups.
+**DatastoreAppend**
+ Can append new backups and create namespaces on a datastore, without reading,
+ restoring, or pruning existing data.
+
**DatastorePowerUser**
Can backup, restore, and prune *owned* backups.
@@ -307,6 +320,9 @@ The following roles exist:
**RemoteSyncOperator**
Is allowed to read data from a remote.
+**RemoteSyncAppendOperator**
+ Is allowed to push append-only backups to a remote.
+
**TapeAdmin**
Can do anything related to tape backup.
--
2.47.3
next prev parent reply other threads:[~2026-11-06 17:24 UTC|newest]
Thread overview: 44+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-06 17:21 [PATCH proxmox{-widget-toolkit,,-backup} v2 00/43] append-only sync jobs and snapshot retention timespan Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 01/43] form: date time field: init with now instead of epoch on empty fields Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 02/43] form: date time field: set min/max value limits passed via config Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 03/43] form: date time field: update to new limits when switching day/time Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 04/43] form: date time field: submit combined datetime instead of item fields Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox-widget-toolkit v2 05/43] form: date time field: track value like other form fields Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox v2 06/43] pbs-api-types: add append only privilege and role Christian Ebner
2026-11-06 17:21 ` [PATCH proxmox v2 07/43] pbs-api-types: add remote datastore append " Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 08/43] pbs-api-types: extend snapshot list items by retention timestamp Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 09/43] pbs-api-types: extend sync job config by retention-timespan parameter Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 10/43] pbs-api-types: add max/default retention timespan property to datastore Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox v2 11/43] pbs-api-types: store: expose max/default retention timespans in status Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 12/43] config/tools: add new fields for sync and snapshot/datastore list items Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 13/43] api: admin: improve code style for status endpoint Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 14/43] client: avoid error in status if user lacks permissions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 15/43] server: allow iterating contents for Datastore.Append permissions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 16/43] api: backup: fix possible information leak in multi-tenant datastores Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 17/43] datastore: s3: fix namespace level bulk remove not honoring group locks Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 18/43] api: backup: allow backup for user/token with append permission Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 19/43] api: allow namespace creation on append permissions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 20/43] api: sync: allow pull to target for user/token with append permission Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 21/43] sync: pull: allow pulling " Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 22/43] sync: push: allow push and ns creation on Remote.DatastoreAppend Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 23/43] datastore: conditionally treat missing manifest as error or benign Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 24/43] api: backup: provide retain-until timestamp for extended prune protection Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 25/43] tools: include retain-until timestamp in snapshot list items Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 26/43] client: backup writer: allow to send retain-until timestamp on backup Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 27/43] sync: push: allow to set retention timestamp for synced snapshots Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 28/43] sync: pull: set retention timestamp from sync job for new snapshots Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 29/43] datastore/config: parse and enforce maximum retention timespan Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 30/43] api: config: allow to set or delete retention timespan for sync jobs Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 31/43] api: admin: allow to modify snapshot retention for root user Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 32/43] tape/s3-refresh: check for retentions outside datastore limits Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 33/43] ui: add retention timespan form and use it for sync job edit window Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 34/43] ui: allow datastore wide max retention timespan configuration Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 35/43] ui: show snapshot retention in datastore contents and allow extension Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 36/43] group: destroy: s3: skip snapshots with active retentions Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 37/43] prune: " Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 38/43] api/ui: expose default retention setting as datastore config option Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 39/43] api: datastore: expose max/default retention timespans in status listing Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 40/43] backup/sync: fallback to datastore default-retention-timespan Christian Ebner
2026-11-06 17:22 ` [PATCH proxmox-backup v2 41/43] client: add flags to set snapshot retention via timestamp/timespan Christian Ebner
2026-11-06 17:22 ` Christian Ebner [this message]
2026-11-06 17:22 ` [PATCH proxmox-backup v2 43/43] docs: document snapshot retention for new backup snapshots Christian Ebner
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=20261106172235.890542-43-c.ebner@proxmox.com \
--to=c.ebner@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