From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id C9DF36163F for ; Tue, 18 Aug 2020 12:52:01 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id C06CD125CC for ; Tue, 18 Aug 2020 12:51:31 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 2ECE5125C2 for ; Tue, 18 Aug 2020 12:51:31 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id EE4494466C for ; Tue, 18 Aug 2020 12:51:30 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Tue, 18 Aug 2020 12:51:18 +0200 Message-Id: <20200818105118.7102-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment 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 Subject: [pbs-devel] [PATCH pbs-docs 3/4] Add section describing acl tool 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: , X-List-Received-Date: Tue, 18 Aug 2020 10:52:01 -0000 This adds a section how to use the acl subcommand to manage user access control Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index 2be49575..5a2838a5 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -374,6 +374,35 @@ following roles exist: **RemoteSyncOperator** Is allowed to read data from a remote. +You can use the ``acl`` subcommand to manage and monitor user permissions. For +example, the command below will add the user ``john@pbs`` as a +**DatastoreAdmin** for the data store ``store1``, located at ``/backup/disk1/store1``: + +.. code-block:: console + + # proxmox-backup-manager acl update /datastore/store1 DatastoreAdmin --userid john@pbs + +You can monitor the roles of each user using the following command: + +.. code-block:: console + + # proxmox-backup-manager acl list + ┌──────────┬──────────────────┬───────────┬────────────────┐ + │ ugid │ path │ propagate │ roleid │ + ╞══════════╪══════════════════╪═══════════╪════════════════╡ + │ john@pbs │ /datastore/disk1 │ 1 │ DatastoreAdmin │ + └──────────┴──────────────────┴───────────┴────────────────┘ + +A single user can be assigned multiple permission sets for different data stores. + +.. Note:: + Naming convention is important here. For data stores on the host, + you must use the convention ``/datastore/{storename}``. For example, to set + permissions for a data store mounted at ``/mnt/backup/disk4/store2``, you would use + ``/datastore/store2`` for the path. For remote stores, use the convention + ``/remote/{remote}/{storename}``, where ``{remote}`` signifies the name of the + remote (see `Remote` below) and ``{storename}`` is the name of the data store on + the remote. :term:`Remote` ~~~~~~~~~~~~~~ -- 2.20.1