From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from gate001.proxmox.com (gate001.proxmox.com [IPv6:2a0f:8001:1:32::40]) by lore.proxmox.com (Postfix) with ESMTPS id 8D2BB1FF0AF for ; Fri, 06 Nov 2026 18:24:43 +0100 (CET) Received: from gate001.proxmox.com (localhost.localdomain [127.0.0.1]) by gate001.proxmox.com (Proxmox) with ESMTP id 0B7AB2185E; Fri, 06 Nov 2026 18:23:40 +0100 (CET) From: Christian Ebner 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 Message-ID: <20261106172235.890542-43-c.ebner@proxmox.com> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20261106172235.890542-1-c.ebner@proxmox.com> References: <20261106172235.890542-1-c.ebner@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Bm-Milter-Handled: 55990f41-d878-4baa-be0a-ee34c49e34d2 X-Bm-Transport-Timestamp: 1793985781802 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.446 Adjusted score from AWL reputation of From: address DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment (newer systems) RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust 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: CZIECAZOFIJ3DSNMPYKW47KBCWCFSTEY X-Message-ID-Hash: CZIECAZOFIJ3DSNMPYKW47KBCWCFSTEY X-MailFrom: c.ebner@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: Complete the list with the newly added roles and permissions and mention their intended usecase. Signed-off-by: Christian Ebner --- 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