From: Dylan Whyte <d.whyte@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH docs 2/6] Disk Management: Add screenshots and explanation
Date: Mon, 7 Sep 2020 17:21:08 +0200 [thread overview]
Message-ID: <20200907152112.14057-3-d.whyte@proxmox.com> (raw)
In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com>
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@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
next prev parent reply other threads:[~2020-09-07 15:21 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-07 15:21 [pbs-devel] [PATCH docs 0/6] Add GUI screenshots and explain Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 1/6] Add screenshots of web interface Dylan Whyte
2020-09-07 15:21 ` Dylan Whyte [this message]
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 3/6] Datastore Config: add screenshots and explanation Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 4/6] User Management: Add " Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 5/6] Network Config: " Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 6/6] Sync Jobs: add " Dylan Whyte
2020-09-08 4:20 ` [pbs-devel] applied: [PATCH docs 0/6] Add GUI screenshots and explain Dietmar Maurer
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200907152112.14057-3-d.whyte@proxmox.com \
--to=d.whyte@proxmox.com \
--cc=pbs-devel@lists.proxmox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox