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 48F3761ABA for ; Mon, 7 Sep 2020 17:21:29 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3BDFAC937 for ; Mon, 7 Sep 2020 17:21:29 +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 09A8ECCD8 for ; Mon, 7 Sep 2020 17:21:27 +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 C5FB844A9A for ; Mon, 7 Sep 2020 17:21:26 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 7 Sep 2020 17:21:08 +0200 Message-Id: <20200907152112.14057-3-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com> References: <20200907152112.14057-1-d.whyte@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.013 Adjusted score from AWL reputation of From: address 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 docs 2/6] Disk Management: Add screenshots and explanation 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, 07 Sep 2020 15:21:29 -0000 This adds screenshots from the web interface for the sections related to disk management and adds explanation of how to carry out tasks using the web interface. Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 41 +++++++++++++++++++++++++++-------- 1 file changed, 32 insertions(+), 9 deletions(-) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index e6357a3e..9b531c3d 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -148,11 +148,18 @@ when setting up the backup server. Disk Management ~~~~~~~~~~~~~~~ + +.. image:: images/screenshots/pbs-gui-disks.png + :width: 230 + :align: right + :alt: List of disks + Proxmox Backup Server comes with a set of disk utilities, which are accessed using the ``disk`` subcommand. This subcommand allows you to initialize disks, create various filesystems, and get information about the disks. -To view the disks connected to the system, use the ``list`` subcommand of +To view the disks connected to the system, navigate to **Administration -> +Disks** in the web interface or use the ``list`` subcommand of ``disk``: .. code-block:: console @@ -174,11 +181,19 @@ To initialize a disk with a new GPT, use the ``initialize`` subcommand: # proxmox-backup-manager disk initialize sdX -You can create an ``ext4`` or ``xfs`` filesystem on a disk, using ``fs -create``. 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 create a datastore at the location -``/mnt/datastore/store1``: +.. image:: images/screenshots/pbs-gui-disks-dir-create.png + :width: 230 + :align: right + :alt: Create a directory + +You can create an ``ext4`` or ``xfs`` filesystem on a disk using ``fs +create``, or by navigating to **Administration -> 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 +create a datastore at the location ``/mnt/datastore/store1``: + +| .. code-block:: console @@ -189,9 +204,17 @@ the disk (in this case ``sdd``). This will create a datastore at the location Percentage done: 99 TASK OK -You can also create a ``zpool`` with various raid levels. The command below -creates a mirrored ``zpool`` using two disks (``sdb`` & ``sdc``) and mounts it -on the root directory (default): +.. image:: images/screenshots/pbs-gui-disks-zfs-create.png + :width: 230 + :align: right + :alt: Create a directory + +You can also create a ``zpool`` with various raid levels from **Administration +-> Disks -> Zpool** in the web interface, or by using ``zpool create``. The command +below creates a mirrored ``zpool`` using two disks (``sdb`` & ``sdc``) and +mounts it on the root directory (default): + +| .. code-block:: console -- 2.20.1