openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-06 06:46:26 +01:00
Code Issues Releases Activity

OBSDOCS-1862: Add missing info about alert emails

Browse Source
This commit is contained in:
Eliska Romanova
2025-05-13 09:07:21 +02:00
committed by openshift-cherrypick-robot
parent b474dc84ea
commit da00a13815
2 changed files with 39 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
modules/monitoring-configuring-alert-routing-console.adoc
View File

@@ -53,6 +53,11 @@ Alternatively, you can go to the same page through the notification drawer. Sele
+
.. Add SMTP configuration details, including the address to send notifications from, the smarthost and port number used for sending emails, the hostname of the SMTP server, and authentication details.
+
[IMPORTANT]
====
Alertmanager requires an external SMTP server to send email alerts. To configure email alert receivers, ensure you have the necessary connection details for an external SMTP server.
====
+
.. Select whether TLS is required.
+
.. Click *Show advanced configuration* if you want to edit the default option not to send resolved alerts to the receiver or edit the body of email notifications configuration.

37
modules/monitoring-configuring-alert-routing-default-platform-alerts.adoc
View File

@@ -85,14 +85,45 @@ receivers:
- name: watchdog
- name: team-frontend-page
pagerduty_configs:
- routing_key: ABCD01234EFGHIJ56789
http_config: # <1>
- routing_key: xxxxxxxxxx # <1>
http_config: # <2>
proxy_from_environment: true
authorization:
credentials: xxxxxxxxxx
# ...
----
<1> Optional: Add custom HTTP configuration for a specific receiver. That receiver does not inherit the global HTTP configuration settings.
<1> Defines the PagerDuty integration key.
<2> Optional: Add the custom HTTP configuration for a specific receiver. That receiver does not inherit the global HTTP configuration settings.
+
--
.Example of configuring email as an alert receiver
[source,yaml]
----
# ...
receivers:
- name: default
- name: watchdog
- name: team-frontend-page
email_configs:
- to: myemail@example.com # <1>
from: alertmanager@example.com # <2>
smarthost: 'smtp.example.com:587' # <3>
auth_username: alertmanager@example.com # <4>
auth_password: password
hello: alertmanager # <5>
# ...
----
<1> Specify an email address to send notifications to.
<2> Specify an email address to send notifications from.
<3> Specify the SMTP server address used for sending emails, including the port number.
<4> Specify the authentication credentials that Alertmanager uses to connect to the SMTP server. This example uses username and password.
<5> Specify the hostname to identify to the SMTP server. If you do not include this parameter, the hostname defaults to `localhost`.
--
+
[IMPORTANT]
====
Alertmanager requires an external SMTP server to send email alerts. To configure email alert receivers, ensure you have the necessary connection details for an external SMTP server.
====
.. Add the routing configuration:
+