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 59E22CBAD for ; Mon, 10 Jul 2023 15:42:05 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 387B2184E6 for ; Mon, 10 Jul 2023 15:42:05 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (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 for ; Mon, 10 Jul 2023 15:42:04 +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 EB378428ED for ; Mon, 10 Jul 2023 15:42:03 +0200 (CEST) From: Philipp Hufnagl To: pbs-devel@lists.proxmox.com Date: Mon, 10 Jul 2023 15:41:50 +0200 Message-Id: <20230710134150.91818-1-p.hufnagl@proxmox.com> X-Mailer: git-send-email 2.39.2 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 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 T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [proxmox-backup] docs: replace concrete device paths with pseudo paths homogeneous through the documentation 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: Mon, 10 Jul 2023 13:42:05 -0000 Having commonly used device paths (like /dev/sdb) in an example command may cause damage if the user simply copies them without checking. With a pseudo device path (like /dev/sdX), they would simply get an error Signed-off-by: Philipp Hufnagl --- docs/storage.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/storage.rst b/docs/storage.rst index f473adbe..60cf268e 100644 --- a/docs/storage.rst +++ b/docs/storage.rst @@ -48,12 +48,12 @@ You can create an ``ext4`` or ``xfs`` filesystem on a disk using ``fs create``, or by navigating to **Administration -> Storage/Disks -> Directory** in the web interface and creating one from there. The following command creates an ``ext4`` filesystem and passes the ``--add-datastore`` parameter, in order to -automatically create a datastore on the disk (in this case ``sdd``). This will +automatically create a datastore on the disk. This will create a datastore at the location ``/mnt/datastore/store1``: .. code-block:: console - # proxmox-backup-manager disk fs create store1 --disk sdd --filesystem ext4 --add-datastore true + # proxmox-backup-manager disk fs create store1 --disk sdX --filesystem ext4 --add-datastore true .. image:: images/screenshots/pbs-gui-disks-zfs-create.png :align: right @@ -61,12 +61,12 @@ create a datastore at the location ``/mnt/datastore/store1``: You can also create a ``zpool`` with various raid levels from **Administration -> Storage/Disks -> ZFS** in the web interface, or by using ``zpool create``. The command -below creates a mirrored ``zpool`` using two disks (``sdb`` & ``sdc``) and +below creates a mirrored ``zpool`` using two disks and mounts it under ``/mnt/datastore/zpool1``: .. code-block:: console - # proxmox-backup-manager disk zpool create zpool1 --devices sdb,sdc --raidlevel mirror + # proxmox-backup-manager disk zpool create zpool1 --devices sdX,sdY --raidlevel mirror .. note:: You can also pass the ``--add-datastore`` parameter here, to automatically create a datastore from the disk. -- 2.39.2