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 44D966306E for ; Mon, 24 Aug 2020 10:17:49 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 38B331B26F for ; Mon, 24 Aug 2020 10:17:49 +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) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 5F6F61B264 for ; Mon, 24 Aug 2020 10:17:48 +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 2F8E94482F for ; Mon, 24 Aug 2020 10:17:48 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 24 Aug 2020 10:17:42 +0200 Message-Id: <20200824081742.13214-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 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 pbs-docs 1/2] Add section "Disk Management" 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, 24 Aug 2020 08:17:49 -0000 Add the section "Disk Management" to the admin guide, explaining the use of the "disk" subcommand of "proxmox-backup-manager" Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 78 +++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index acf07930..84e1eb72 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -146,6 +146,84 @@ when setting up the backup server. filesystem configuration from being supported for a datastore. For example, ``ext3`` as a whole or ``ext4`` with the ``dir_nlink`` feature manually disabled. +Disk Management +~~~~~~~~~~~~~~~ +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 +``disk``: + +.. code-block:: console + + # proxmox-backup-manager disk list + ┌──────┬────────┬─────┬───────────┬─────────────┬───────────────┬─────────┬────────┐ + │ name │ used │ gpt │ disk-type │ size │ model │ wearout │ status │ + ╞══════╪════════╪═════╪═══════════╪═════════════╪═══════════════╪═════════╪════════╡ + │ sda │ lvm │ 1 │ hdd │ 34359738368 │ QEMU_HARDDISK │ - │ passed │ + ├──────┼────────┼─────┼───────────┼─────────────┼───────────────┼─────────┼────────┤ + │ sdb │ unused │ 1 │ hdd │ 68719476736 │ QEMU_HARDDISK │ - │ passed │ + ├──────┼────────┼─────┼───────────┼─────────────┼───────────────┼─────────┼────────┤ + │ sdc │ unused │ 1 │ hdd │ 68719476736 │ QEMU_HARDDISK │ - │ passed │ + └──────┴────────┴─────┴───────────┴─────────────┴───────────────┴─────────┴────────┘ + +To initialize a disk with a new GPT, use the ``initialize`` subcommand: + +.. code-block:: console + + # 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``: + +.. code-block:: console + + # proxmox-backup-manager disk fs create store1 --disk sdd --filesystem ext4 --add-datastore true + register worker thread + register worker + FILE: "/var/log/proxmox-backup/tasks/EA/UPID:pbs:000016F6:001851EA:00000000:5F3D0A26:dircreate:store1:root@pam:" + create datastore 'store1' on disk sdd + Percentage done: 1 + ... + Percentage done: 99 + TASK OK + Detected stopped UPID UPID:pbs:000016F6:001851EA:00000000:5F3D0A26:dircreate:store1:root@pam: + unregister worker + +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): + +.. code-block:: console + + # proxmox-backup-manager disk zpool create zpool1 --devices sdb,sdc --raidlevel mirror + register worker thread + register worker + FILE: "/var/log/proxmox-backup/tasks/F5/UPID:pbs:00001544:001814F5:00000000:5F3D098A:zfscreate:zpool1:root@pam:" + create Mirror zpool 'zpool1' on devices 'sdb,sdc' + # "zpool" "create" "-o" "ashift=12" "zpool1" "mirror" "sdb" "sdc" + + TASK OK + Detected stopped UPID UPID:pbs:00001544:001814F5:00000000:5F3D098A:zfscreate:zpool1:root@pam: + unregister worker + +.. note:: + You can also pass the ``--add-datastore`` parameter here, to automatically + create a datastore from the disk. + +You can use ``disk fs list`` and ``disk zpool list`` to keep track of your +filesystems and zpools respectively. + +If a disk supports S.M.A.R.T. capability, and you have this enabled, you can +display S.M.A.R.T. attributes using the command: + +.. code-block:: console + + # proxmox-backup-manager disk smart-attributes sdX Datastore Configuration ~~~~~~~~~~~~~~~~~~~~~~~ -- 2.20.1