From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9]) by lore.proxmox.com (Postfix) with ESMTPS id A3EFD1FF173 for ; Mon, 11 Nov 2024 16:44:19 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3C819FDD2; Mon, 11 Nov 2024 16:44:16 +0100 (CET) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Mon, 11 Nov 2024 16:43:53 +0100 Message-Id: <20241111154353.482734-32-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241111154353.482734-1-c.ebner@proxmox.com> References: <20241111154353.482734-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.032 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 Subject: [pbs-devel] [PATCH v7 proxmox-backup 31/31] docs: add section for sync jobs in push direction X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" Documents the caveats of sync jobs in push direction, explicitly recommending setting up dedicted remotes for these sync jobs. Signed-off-by: Christian Ebner --- changes since version 6: - Adapt to changes and extend with namespace min version requirement docs/managing-remotes.rst | 40 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/docs/managing-remotes.rst b/docs/managing-remotes.rst index dd43ccd2b..a7fd5143d 100644 --- a/docs/managing-remotes.rst +++ b/docs/managing-remotes.rst @@ -227,3 +227,43 @@ the web interface or using the ``proxmox-backup-manager`` command-line tool: .. code-block:: console # proxmox-backup-manager sync-job update ID --rate-in 20MiB + +Sync Direction Push +^^^^^^^^^^^^^^^^^^^ + +Sync jobs can be configured for pull or push direction. Sync jobs in push +direction are not identical in behaviour because of the limited access to the +target datastore via the remote servers API. Most notably, pushed content will +always be owned by the user configured in the remote configuration, being +independent from the local user as configured in the sync job. Latter is used +exclusively for permission check and scope checks on the pushing side. + +.. note:: It is strongly advised to create a dedicated remote configuration for + each individual sync job in push direction, using a dedicated user on the + remote. Otherwise, sync jobs pushing to the same target might remove each + others snapshots and/or groups, if the remove vanished flag is set or skip + snapshots if the backup time is not incremental. + This is because the backup groups on the target are owned by the user + given in the remote configuration. + +The following permissions are required for a sync job in push direction: + +#. ``Remote.Audit`` on ``/remote/{remote}`` and ``Remote.DatastoreBackup`` on + ``/remote/{remote}/{remote-store}/{remote-ns}`` path or subnamespace. +#. At least ``Datastore.Read`` on the local source datastore namespace + (``/datastore/{store}/{ns}``) or ``Datastore.Backup`` if owner of the sync + job. +#. ``Remote.DatastorePrune`` on ``/remote/{remote}/{remote-store}/{remote-ns}`` + path to remove vanished snapshots and groups. Make sure to use a dedicated + remote for each sync job in push direction as noted above. +#. ``Remote.DatastoreModify`` on ``/remote/{remote}/{remote-store}/{remote-ns}`` + path to remove vanished namespaces. A remote user with limited access should + be used on the remote backup server instance. Consider the implications as + noted below. + +.. note:: ``Remote.DatastoreModify`` will allow to remove whole namespaces on the + remote target datastore, independent of ownership. Make sure the user as + configured in remote.cfg has limited permissions on the remote side. + +.. note:: Sync jobs in push direction require namespace support on the remote + Proxmox Backup Server instance (minimum version 2.2). -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel