🚀 KubeSphere 3.1.1 is now available as it extends Kubernetes from the cloud to the edge. Read the introduction for 3.1.x → close
  • English
    • English
    • 简体中文
    1. 1.Experience account: demo1 / Demo123
    2. 2.This account is only allowed to view parts of UI
    3. 3.It's recommended that install KubeSphere in your environment
  •  Star
  1. Documentation / 
  2. Cluster Administration / 
  3. Platform Settings / 
  4. Notification Management / 
  5. Configure Email Notifications

Cluster Administration

Last updated:
    Edit

    Configure Email Notifications

    This tutorial demonstrates how to configure your email server and add recipients, who can receive email notifications for alerting policies.

    Configure the Email Server

    1. Log in to the web console with an account granted the role platform-admin.

    2. Click Platform in the top-left corner and select Platform Settings.

    3. Navigate to Email under Notification Management.

      emai-server

    4. Under Server Settings, configure your email server by filling in the following fields.

      • SMTP Server Address: The SMTP server address that can provide email services. The port is usually 25.
      • Use SSL Secure Connection: SSL can be used to encrypt emails, thereby improving the security of information transmitted by email. Usually you have to configure the certificate for the email server.
      • SMTP User: The SMTP account.
      • SMTP Password: The SMTP account password.
      • Sender Email Address: The sender’s email address. Customized email addresses are currently not supported.

    5. Click Save.

    Add Recipients

    1. Under Recipient Settings, enter a recipient’s email address and click Add.

    2. After it is added, the email address of a recipient will be listed under Recipient Settings. You can add up to 50 recipients and all of them will be able to receive email notifications of alerts.

    3. To remove a recipient, hover over the email address you want to remove, then click the trash bin icon that appears.

    4. To make sure notifications will be sent to your recipients, turn on Receive Notifications and click Update.

      Note

      If you change the existing configuration, you must click Update to apply it.

    Receive Email Notifications

    After you configure the email server and add recipients, you need to enable KubeSphere Alerting and create an alerting policy for workloads or nodes. Once it is triggered, all the recipients can receive email notifications.

    The image below is an email notification example:

    example-email-notification

    Note

    • If you update your email server configuration, KubeSphere will send email notifications based on the latest configuration.
    • By default, KubeSphere sends notifications for the same alert about every 12 hours. The notification repeat interval is mainly controlled by repeat_interval in the Secret alertmanager-main in the project kubesphere-monitoring-system. You can customize the interval as needed.
    • As KubeSphere has built-in alerting policies, if you do not set any customized alerting policies, your recipient can still receive email notifications once a built-in alerting policy is triggered.

    Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

    Previous : Customize Basic Information
    What’s on this Page