* [pbs-devel] [PATCH pbs-docs 1/2] Add section "Disk Management"
@ 2020-08-24 8:17 Dylan Whyte
2020-08-25 7:32 ` Dietmar Maurer
0 siblings, 1 reply; 2+ messages in thread
From: Dylan Whyte @ 2020-08-24 8:17 UTC (permalink / raw)
To: pbs-devel
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 <d.whyte@proxmox.com>
---
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
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [pbs-devel] [PATCH pbs-docs 1/2] Add section "Disk Management"
2020-08-24 8:17 [pbs-devel] [PATCH pbs-docs 1/2] Add section "Disk Management" Dylan Whyte
@ 2020-08-25 7:32 ` Dietmar Maurer
0 siblings, 0 replies; 2+ messages in thread
From: Dietmar Maurer @ 2020-08-25 7:32 UTC (permalink / raw)
To: Proxmox Backup Server development discussion, Dylan Whyte
applied, but removed debug output. See comments below:
> On 08/24/2020 10:17 AM Dylan Whyte <d.whyte@proxmox.com> wrote:
>
>
> 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 <d.whyte@proxmox.com>
> ---
> 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:"
Above is debug output ...
> + 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
Above is debug output ...
> +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:"
Above is debug output ...
> + 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
Above is debug output ...
> +.. 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
>
>
>
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2020-08-25 7:32 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-24 8:17 [pbs-devel] [PATCH pbs-docs 1/2] Add section "Disk Management" Dylan Whyte
2020-08-25 7:32 ` Dietmar Maurer
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal