[pve-devel] [PATCH docs] add section disk health monitoring to sysadmin chapter

[Dominik Csapak]

explain that we ship smartmontools, basic usage of smartctl
default behaviour of smartd, and where to get more information

Signed-off-by: Dominik Csapak <d.csapak at proxmox.com>
---
 Makefile                        |  1 +
 pve-disk-health-monitoring.adoc | 42 +++++++++++++++++++++++++++++++++++++++++
 sysadmin.adoc                   |  4 ++++
 3 files changed, 47 insertions(+)
 create mode 100644 pve-disk-health-monitoring.adoc

diff --git a/Makefile b/Makefile
index cf166fe..0cbfa71 100644
--- a/Makefile
+++ b/Makefile
@@ -109,6 +109,7 @@ SYSADMIN_PARTS=					\
 	pve-network				\
 	pve-package-repos			\
 	system-software-updates			\
+	pve-disk-health-monitoring		\
 	local-lvm				\
 	local-zfs
 
diff --git a/pve-disk-health-monitoring.adoc b/pve-disk-health-monitoring.adoc
new file mode 100644
index 0000000..2bb740b
--- /dev/null
+++ b/pve-disk-health-monitoring.adoc
@@ -0,0 +1,42 @@
+Disk Health Monitoring
+----------------------
+include::attributes.txt[]
+
+Altough a robust and redundant storage is recommended,
+it can be very helpful to monitor the health of your local disks.
+
+Starting with {pve} 4.3, the package smartmontools footnote:[smartmontools homepage https://www.smartmontools.org]
+is installed and required. This is a set of tools to monitor and control
+the S.M.A.R.T. system for local hard disks.
+
+You can get the status of a disk by issuing the following command:
+----
+# smartctl -a /dev/sdX
+----
+
+where /dev/sdX is the path to one of your local disks.
+
+If the output says:
+
+----
+SMART support is: Disabled
+----
+
+you can enable it with the command:
+
+----
+# smartctl -s on /dev/sdX
+----
+
+For more information on how to use smartctl, please see `man smartctl`.
+
+By default, smartmontools daemon smartd is active and enabled, and scans
+the disks under /dev/sdX and /dev/hdX every 30 minutes for errors and warnings, and sends an
+e-mail to root if it detects a problem.
+
+For more information about how to configure smartd, please see `man smartd` and
+`man smartd.conf`.
+
+If you use your hard disks with a hardware raid controller, there are most likely tools
+to monitor the disks in the raid array and the array itself. For more information about this,
+please refer to the vendor of your raid controller.
diff --git a/sysadmin.adoc b/sysadmin.adoc
index ccba5c9..c9e0ae6 100644
--- a/sysadmin.adoc
+++ b/sysadmin.adoc
@@ -39,6 +39,8 @@ See Also
 
 * link:/wiki/System_Software_Updates[System Software Updates]
 
+* link:/wiki/Disk_Health_Monitoring[Disk Health Monitoring]
+
 * link:/wiki/Logical_Volume_Manager_(LVM)[Logical Volume Manager (LVM)]
 
 * link:/wiki/ZFS_on_Linux[ZFS on Linux]
@@ -54,6 +56,8 @@ include::system-software-updates.adoc[]
 
 include::pve-network.adoc[]
 
+include::pve-disk-health-monitoring.adoc[]
+
 include::local-lvm.adoc[]
 
 include::local-zfs.adoc[]
-- 
2.1.4