[pbs-devel] [PATCH docs 2/6] Disk Management: Add screenshots and explanation

Dylan Whyte d.whyte at proxmox.com
Mon Sep 7 17:21:08 CEST 2020


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 <d.whyte at proxmox.com>
---
 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






More information about the pbs-devel mailing list