Notifications v1.3

With Hybrid Manager (HM), you can customize the types of notifications you want to receive. The two types of notification channels are:

User notifications You can receive notifications via email, HM inbox, or both. These notifications are for all users who have enabled them and if their role allows it.

System notifications You can receive notifications via email (mail group), webhook, pager duty, or any combination. These notifications are triggered once per event, primarily to automate tasks in your organization.

The user's role in HM determines the extent of their access to notification preferences. The notifications are categorized into the following preference sections:

  • Account For user notification channels.
  • Global For user and system notification channels.
  • Projects For user and system notification channels.

The notifications under the Account preference section are:

  • New project role assigned to you
  • Project role unassigned from you
  • The personal access key is about to expire

The notifications under the Global preference section are:

  • New project created
  • The machine access key is about to expire
Note

This section is visible only to the organization owner.

The notifications under the Projects preference section are:

  • Active cluster paused
  • Paused cluster reactivated

Configuring notifications

Project owners/editors and organization owners/admins can enable/disable notifications for the events visible to them. They can receive notifications in the HM inbox, by email, or both.

Notification settings made by a user apply only to that user. If an email notification is enabled, the email is sent to the email address associated with the user's login.

System notification channels can be configured at the global level by the organization owner or at the project level by the project owner. By default, each organization's project inherits the global-level system notifications channel. However, you can enable/disable or reconfigure the system notifications channel at the project level to override the default settings.

Configure notifications at the global level

Only the organization owner can set the global-level notifications.

Webhook

  1. In the HM console, from your profile menu, select Settings.

  2. Select the Notifications tab.

  3. Select Webhook and provide the details:

    1. Host URL of the Webhook

    2. Method of the Webhook: POST or PUT

    3. Optionally, provide one of the following authentication parameters:

      • Basic auth username and password
      • Bearer token
  4. Select Save.

Pager Duty

Before configuring the Pager Duty notification channel:

  • You need access to a Pager Duty account with elevated privileges.
  • Pager Duty Service must be created and configured with Events API v2 integration.
  • In your Pager Duty account, navigate to the desired service and access its Integrations settings.
  • Add an Events API v2 integration and configure it according to your requirements.
  • Copy the integration key (routing key) provided by Pager Duty for the newly created integration.

Then you can configure the channel:

  1. In the HM console, from your profile menu, select Settings.
  2. Select the Notifications tab.
  3. Select Pager Duty and set the integration key (routing key).
  4. Select Save.

Email

  1. In the HM console, from your profile menu, select Settings.

  2. Select the Notifications tab.

  3. Select Email and enter the details:

    1. Email To Optionally, email group for system email notifications.
    2. Email From Email that's sending the notification.
    3. Host URL of the email service.
    4. Port Port of the email service.
    5. Username Username of the email service.
    6. Password Password of the email service
  4. Select Save.

Configure notifications at project level

Project-level notification settings can override global settings. Each project can have a unique configuration.

  1. In the HM console, select the Projects tab.
  2. Select any project.
  3. Go to the Project Overview page.
  4. In the left navigation, select Settings.
  5. Select Notifications.
  6. Specify settings as described in Webhook, Pager Duty, or Email.

Viewing notifications in the HM console

Users in the following roles can view the notifications:

  • Organization owners can view the global notifications.
  • Project owners/editors can view the project notifications.
  • All users can view their account notifications.

Each notification indicates the level and project the user belongs to with multiple roles assigned in HM.

Select the bell icon at the top of the HM console to view notifications. You can read a notification, mark it as unread, or archive it.

Managing notification preferences

  1. In the HM console, from your profile menu, select My Account.
  2. Select the Notifications tab. Notifications are grouped by account, global, and projects available to you.
  3. Scroll to the Account, Global, or Project section to view the events you want to manage.
  4. Select the right arrow next to the entity to expand the list of events.
  5. For each notification, you can:
    • Use the toggle in front of the event name to opt in or out of receiving notifications for a particular event.
    • Customize the email and HM console (in-app) notifications for the event by using the check box for Email and In-app.