[pbs-devel] [PATCH proxmox-backup 5/5] docs: zfs: update documentation about ZED

Stoiko Ivanov s.ivanov at proxmox.com
Wed May 11 16:06:35 CEST 2022


This closely follows commit aa425868069818167ff0a3cca5c64a2acc88173e
in pve-docs.

Signed-off-by: Stoiko Ivanov <s.ivanov at proxmox.com>
---
 docs/local-zfs.rst | 21 ++++++++-------------
 1 file changed, 8 insertions(+), 13 deletions(-)

diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst
index 4c4bd387..7b2d3850 100644
--- a/docs/local-zfs.rst
+++ b/docs/local-zfs.rst
@@ -211,27 +211,22 @@ Usually `grub.cfg` is located in `/boot/grub/grub.cfg`
 Activate e-mail notification
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-ZFS comes with an event daemon, which monitors events generated by the
-ZFS kernel module. The daemon can also send emails on ZFS events like
-pool errors. Newer ZFS packages ship the daemon in a separate package,
-and you can install it using `apt-get`:
+ZFS comes with an event daemon ``ZED``, which monitors events generated by the
+ZFS kernel module. The daemon can also send emails on ZFS events like pool
+errors. Newer ZFS packages ship the daemon in a separate package ``zfs-zed``,
+which should already be installed by default in `Proxmox Backup`_.
 
-.. code-block:: console
-
-  # apt-get install zfs-zed
-
-To activate the daemon, it is necessary to to uncomment the ZED_EMAIL_ADDR
-setting, in the file `/etc/zfs/zed.d/zed.rc`.
+You can configure the daemon via the file ``/etc/zfs/zed.d/zed.rc`` with your
+favorite editor. The required setting for email notfication is
+``ZED_EMAIL_ADDR``, which is set to ``root`` by default.
 
 .. code-block:: console
 
   ZED_EMAIL_ADDR="root"
 
-Please note that Proxmox Backup forwards mails to `root` to the email address
+Please note that `Proxmox Backup`_ forwards mails to `root` to the email address
 configured for the root user.
 
-IMPORTANT: The only setting that is required is `ZED_EMAIL_ADDR`. All
-other settings are optional.
 
 Limit ZFS memory usage
 ^^^^^^^^^^^^^^^^^^^^^^
-- 
2.30.2






More information about the pbs-devel mailing list