In Rancher 2.5, the notifier application was improved. There are now two ways to enable notifiers. The older way is documented in this section, and the new application for notifiers is documented here.

Notifiers are services that inform you of alert events. You can configure notifiers to send alert notifications to staff best suited to take corrective action.

Rancher integrates with a variety of popular IT services, including:

• Slack: Send alert notifications to your Slack channels.
• Email: Choose email recipients for alert notifications.
• PagerDuty: Route notifications to staff by phone, SMS, or personal email.
• WebHooks: Update a webpage with alert notifications.
• WeChat: (Available as of v2.2.0) Send alert notifications to your Enterprise WeChat contacts.
• DingTalk: (Available as of v2.4.6) Send alert notifications to DingTalk using a webhook.
• Microsoft Teams: (Available as of v2.4.6) Send alert notifications to Teams using a webhook.

This section covers the following topics:

• Roles-based access control for notifiers
• Adding notifiers
• Configuration
• Managing notifiers
• Example payload for a webhook alert notifier

Roles-based Access Control for Notifiers

Notifiers are configured at the cluster level. This model ensures that only cluster owners need to configure notifiers, leaving project owners to simply configure alerts in the scope of their projects. You don’t need to dispense privileges like SMTP server access or cloud account access.

Adding Notifiers

Set up a notifier so that you can begin configuring and sending alerts.

1. From the Global View, open the cluster that you want to add a notifier.
2. From the main menu, select Tools > Notifiers. Then click Add Notifier.
3. Select the service you want to use as your notifier, and then fill out the form. For help filling out the form, refer to the configuration section below.
4. Click Test. You should receive a notification confirming that the notifier is configured correctly.
5. Click Add to complete adding the notifier.

Result: Your notifier is added to Rancher.

Configuration

• Slack
• Email
• PagerDuty
• Webhook
• WeChat
• DingTalk
• Microsoft Teams

Slack

Validation: Click Test. If the test is successful, the Slack channel you’re configuring for the notifier outputs Slack setting validated.

Email

SMTP Server Configuration:

Validation: Click Test. If the test is successful, Rancher prints settings validated and you receive a test notification email.

PagerDuty

Validation: Click Test. If the test is successful, your PagerDuty endpoint outputs PagerDuty setting validated.

Webhook

Validation: Click Test. If the test is successful, the URL you’re configuring as a notifier outputs Webhook setting validated.

WeChat

Available as of v2.2.0

Validation: Click Test. If the test is successful, you should receive an alert message.

DingTalk

Available as of v2.4.6

Validation: Click Test. If the test is successful, the DingTalk notifier output is DingTalk setting validated.

Microsoft Teams

Available as of v2.4.6

Validation: Click Test. If the test is successful, the Teams notifier output is MicrosoftTeams setting validated.

Managing Notifiers

After you set up notifiers, you can manage them. From the Global view, open the cluster that you want to manage your notifiers. Select Tools > Notifiers. You can:

• Edit their settings that you configured during their initial setup.
• Clone them, to quickly setup slightly different notifiers.
• Delete them when they’re no longer necessary.

Example Payload for a Webhook Alert Notifier

{
  "receiver": "c-2a3bc:kube-components-alert",
  "status": "firing",
  "alerts": [
    {
      "status": "firing",
      "labels": {
        "alert_name": "Scheduler is unavailable",
        "alert_type": "systemService",
        "cluster_name": "mycluster (ID: c-2a3bc)",
        "component_name": "scheduler",
        "group_id": "c-2a3bc:kube-components-alert",
        "logs": "Get http://127.0.0.1:10251/healthz: dial tcp 127.0.0.1:10251: connect: connection refused",
        "rule_id": "c-2a3bc:kube-components-alert_scheduler-system-service",
        "severity": "critical"
      },
      "annotations": {},
      "startsAt": "2020-01-30T19:18:13.321684733Z",
      "endsAt": "0001-01-01T00:00:00Z",
      "generatorURL": ""
    }
  ],
  "groupLabels": {
    "component_name": "scheduler",
    "rule_id": "c-2a3bc:kube-components-alert_scheduler-system-service"
  },
  "commonLabels": {
    "alert_name": "Scheduler is unavailable",
    "alert_type": "systemService",
    "cluster_name": "mycluster (ID: c-2a3bc)"
  }
}

What’s Next?

After creating a notifier, set up alerts to receive notifications of Rancher system events.

• Cluster owners can set up alerts at the cluster level.
• Project owners can set up alerts at the project level.