From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pbs-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id EA7761FF17C
for <inbox@lore.proxmox.com>; Wed, 2 Apr 2025 11:58:06 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 47D20E358;
Wed, 2 Apr 2025 11:57:56 +0200 (CEST)
Message-ID: <f7133e37-d16b-4484-ba61-8ffb63f6a3d8@proxmox.com>
Date: Wed, 2 Apr 2025 11:57:22 +0200
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>, Maximiliano Sandoval <m.sandoval@proxmox.com>
References: <20250327104730.199623-1-m.sandoval@proxmox.com>
<20250327104730.199623-7-m.sandoval@proxmox.com>
Content-Language: en-US, de-DE
From: Christian Ebner <c.ebner@proxmox.com>
In-Reply-To: <20250327104730.199623-7-m.sandoval@proxmox.com>
X-SPAM-LEVEL: Spam detection results: 0
AWL -0.369 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_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible
spam tricks
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: Re: [pbs-devel] [PATCH backup v2 7/7] docs: client: add section
about system credentials
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Content-Transfer-Encoding: 7bit
Content-Type: text/plain; charset="us-ascii"; Format="flowed"
Errors-To: pbs-devel-bounces@lists.proxmox.com
Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com>
some nits inline
On 3/27/25 11:47, Maximiliano Sandoval wrote:
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
> docs/backup-client.rst | 36 ++++++++++++++++++++++++++++++++++++
> 1 file changed, 36 insertions(+)
>
> diff --git a/docs/backup-client.rst b/docs/backup-client.rst
> index e11c0142..aea63bd1 100644
> --- a/docs/backup-client.rst
> +++ b/docs/backup-client.rst
> @@ -44,6 +44,9 @@ user\@pbs!token@host:store ``user@pbs!token`` host:8007 store
> [ff80::51]:1234:mydatastore ``root@pam`` [ff80::51]:1234 mydatastore
> ================================ ================== ================== ===========
>
> +
> +.. _environment-variables:
> +
> Environment Variables
> ---------------------
>
> @@ -89,6 +92,39 @@ Environment Variables
> you can add arbitrary comments after the first newline.
>
>
> +System Credentials
> +------------------
> +
> +Some of the :ref:`environment variables <environment-variables>` above can be
> +set using `system credentials <https://systemd.io/CREDENTIALS/>`_ instead.
> +
> +============================ ==============================================
> +Environment Variable Credential Name Equivalent
> +============================ ==============================================
> +``PBS_REPOSITORY`` ``proxmox-backup-client.repository``
> +``PBS_PASSWORD`` ``proxmox-backup-client.password``
> +``PBS_ENCRYPTION_PASSWORD`` ``proxmox-backup-client.encryption-password``
> +``PBS_FINGERPRINT`` ``proxmox-backup-client.fingerprint``
> +============================ ==============================================
> +
> +For example, a credential for the repository password can be stored in an
this sounds a bit redundant, maybe just
```
For example, the repository password can ...
```
> +encrypted file as follows:
> +
> +.. code-block:: console
> +
> + # systemd-ask-password -n | systemd-creds encrypt --name=proxmox-backup-client.password - my-api-token.cred
> +
> +The credential can be then reused inside of unit files or in a transient scope
The credential can then be reused ...
> +unit as follows:
> +
> +.. code-block:: console
> +
> + # systemd-run --pipe --wait \
> + --property=LoadCredentialEncrypted=proxmox-backup-client.password:my-api-token.cred \
This required the full path to the encrypted file to work as expected,
so maybe that should be mentioned as otherwise this trips up first users
(me included).
> + --property=SetCredential=proxmox-backup-client.repository:'my_default_repository' \
> + proxmox-backup-client ...
> +
> +
> Output Format
> -------------
>
Further, it might be nice to have an example on how to invoke the client
if the credentials are passed in as system credentials instead, e.g.
```
systemd-run --pipe --wait \\
--property=LoadCredential=proxmox-backup-client.repository \\
--property=LoadCredential=proxmox-backup-client.password \\
--property=LoadCredential=proxmox-backup-client.encryption-password \\
--property=LoadCredential=proxmox-backup-client.fingerprint \\
proxmox-backup-client ...
```
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel