From aa8d4dab202585d6e6f04be63d899e21d751c12b Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Thu, 8 May 2025 12:29:25 +1000 Subject: [PATCH] doc/mgr: edit alerts.rst Edit doc/mgr/alerts.rst as part of the project to determine where the error is in https://github.com/ceph/ceph/pull/62782 that prevents the Jenkins tests from passing. This commit adds to the work done in https://github.com/ceph/ceph/pull/62782 by correcting some of the English that was present in that PR. This is a change to one of twenty-five files in https://github.com/ceph/ceph/pull/62782, and this commit represents one of what will be at least twenty-five other commits made to track this error down. Signed-off-by: Zac Dover (cherry picked from commit db28c1f32ff67bd1087866c7976233e8ab23fa2c) --- doc/mgr/alerts.rst | 67 +++++++++++++++++++++++++++++----------------- 1 file changed, 42 insertions(+), 25 deletions(-) diff --git a/doc/mgr/alerts.rst b/doc/mgr/alerts.rst index 319d9d9278701..dae1f78acfc9a 100644 --- a/doc/mgr/alerts.rst +++ b/doc/mgr/alerts.rst @@ -2,57 +2,74 @@ Alerts module ============= The alerts module can send simple alert messages about cluster health -via e-mail. In the future, it will support other notification methods +via e-mail. In the future, it will support other notification methods as well. :note: This module is *not* intended to be a robust monitoring - solution. The fact that it is run as part of the Ceph cluster + solution. The fact that it is run as part of the Ceph cluster itself is fundamentally limiting in that a failure of the - ceph-mgr daemon prevents alerts from being sent. This module + ``ceph-mgr`` daemon prevents alerts from being sent. This module can, however, be useful for standalone clusters that exist in - environments where existing monitoring infrastructure does not + environments where other monitoring infrastructure does not exist. Enabling -------- -The *alerts* module is enabled with:: +Enable the ``alerts`` module by running the following command: - ceph mgr module enable alerts +.. prompt:: bash # + + ceph mgr module enable alerts Configuration ------------- -To configure SMTP, all of the following config options must be set:: +All of the following config options must be set when configuring SMTP. When +setting ``mgr/alerts/smtp_destination``, specify multiple email addresses by +separating them with commas. + +.. prompt:: bash # + + ceph config set mgr mgr/alerts/smtp_host ** + ceph config set mgr mgr/alerts/smtp_destination ** + ceph config set mgr mgr/alerts/smtp_sender ** + +The alerts module uses SSL and port 465 by default. These settings can be changed by running commands of the following forms: - ceph config set mgr mgr/alerts/smtp_host ** - ceph config set mgr mgr/alerts/smtp_destination ** - ceph config set mgr mgr/alerts/smtp_sender ** +.. prompt:: bash # -By default, the module will use SSL and port 465. To change that,:: + ceph config set mgr mgr/alerts/smtp_ssl false # if not SSL + ceph config set mgr mgr/alerts/smtp_port ** # if not 465 - ceph config set mgr mgr/alerts/smtp_ssl false # if not SSL - ceph config set mgr mgr/alerts/smtp_port ** # if not 465 +To authenticate to the SMTP server, you must set the user and password: -To authenticate to the SMTP server, you must set the user and password:: +.. prompt:: bash # - ceph config set mgr mgr/alerts/smtp_user ** - ceph config set mgr mgr/alerts/smtp_password ** + ceph config set mgr mgr/alerts/smtp_user ** + ceph config set mgr mgr/alerts/smtp_password ** -By default, the name in the ``From:`` line is simply ``Ceph``. To -change that (e.g., to identify which cluster this is),:: +By default, the name in the ``From:`` line is simply ``Ceph``. To change this +default (that is, to identify which cluster this is), run a command of the +following form: - ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo' +.. prompt:: bash # -By default, the module will check the cluster health once per minute -and, if there is a change, send a message. To change that -frequency,:: + ceph config set mgr mgr/alerts/smtp_from_name 'Ceph Cluster Foo' - ceph config set mgr mgr/alerts/interval ** # e.g., "5m" for 5 minutes +By default, the alert module checks the cluster health once per minute and +sends a message if there a change to the cluster's health status. Change the +frequency of the alert module's cluster health checks by running a command of the following form: + +.. prompt:: bash # + + ceph config set mgr mgr/alerts/interval ** # e.g., "5m" for 5 minutes Commands -------- -To force an alert to be send immediately,:: +To force an alert to be sent immediately, run the following command: + +.. prompt:: bash # - ceph alerts send + ceph alerts send -- 2.39.5