Skip to content

Lab 4: Tell the world about EDA#

Imagine having a powerful system that knows everything about your network—every event, every alert, all the fine details—but it can’t communicate with anyone else. Frustrating, right? It’s like completing a massive puzzle, but never showing anyone the finished picture!

That’s why integration is key, and the Notifier app steps in. It bridges the gap, making sure that all those critical events and conditions are delivered exactly where they need to go, ensuring your network’s intelligence isn’t just locked away but actually working for you.

Apps?

Almost everything in EDA is considered an Application (App), for example the Fabrics app that you interacted with in Lab 1 or VNET app in Lab 2.
Apps extend the core functionality of EDA by introducing new declarative abstractions, integrations with other systems, and more.

The Notifier app#

Notifier lets you craft and deliver personalized alerts tailored to your specific events and conditions. Whether you need straightforward alerts or more customized notifications using the power of EQL (EDA Query Language), the Notifier app gives you full control over how and when notifications are triggered.

Step1: Install it#

Apps can be installed using the App Store UI or by applying a resource directly via any of the programmable interfaces.
The App Store method is great for "shopping" around for apps, while applying a YAML resource allows you to automate this process at will.

Here is how to install the notifier app using the App Store UI.

Select the System Administration item in the left menu of the EDA UI.

p1

You will find yourself in the App Store UI.

In the filter menu select the Catalog drop down menu and select 3rd Party Catalog.

p2

Select the notifier app card to open up the application page.

p3

Press Install and wait a couple of seconds until the app is installed.

p4

CLI installation option

Alternatively, applying the below resource installs of the notifier app.

You can copy the entire command in the 1st tab and paste it in the terminal of your VM.

kubectl apply -f - <<'EOF'
apiVersion: appstore.eda.nokia.com/v1
kind: AppInstall
metadata:
  name: notifier.nokia
spec:
  app: notifier
  catalog: kmrd-eda-catalog
  vendor: nokia
  version:
    type: semver
    value: v1.0.3
EOF

apiVersion: appstore.eda.nokia.com/v1
kind: AppInstall
metadata:
  name: notifier.nokia
spec:
  app: notifier
  catalog: kmrd-eda-catalog
  vendor: nokia
  version:
    type: semver
    value: v1.0.3

Step2: Use it#

The Notifier app works with two key resources: a Provider and a Notifier.

The Provider is a notification destination such as Discord, Team, Email, etc. While the Notifier defines the content of the notification and the specific conditions that trigger it. Together, they ensure your notifications go exactly where they’re needed, with the right information.

Step2.1: Alarm-based notifier#

An alarm-based notifier sends notifications triggered by alarms raised by EDA. You can choose to include or exclude specific alarms, ensuring you only get the alerts you need. Plus, you’ll be notified when those alarms are cleared, keeping everything neat and tidy.

Configure a Discord Provider#

To create a Provider using the UI:

  • Switch back to the Main panel if you're still in the App Store UI.
  • Navigate to the Notifier resource category, select Provider and press Create at the top right corner of the UI.
  • Fill in the Provider form by giving the Provider a name. For instance - discord - since we will be sending notifications to a Discord channel.

  • Under the Specification section, set the URI to a Discord webhook URL as per the table below:

    ID Provider URI
    1 discord://ngfxfs_dqpVeqfDkiE71H3PKGEoy5Wscn5b_ryUcY4DsvqU-GOVsKt9lDIsHZOEDHM4X@1288084599100014625
    2 discord://mGfzyFdGpzS3JVs6Z7Lf_qr4ItHDQuHoXT4b1eJADMgLnS55DeUxNBYJJLVzcreoZU-s@1288086952611942451
    3 discord://k1qfnWxXxJPZaFgE2M2F-QOfMz9n-Sb5H-CAqvaoWmYax3zawZEwqgg96-Os1xbxvkdr@1288087087714668584
    4 discord://qXKnozshwfWOwToWgNuYSuzIsbRCwWqzhWaJBKTdADVpBHYje1K1cRBV5LBlLnsUxM3E@1288087170959278193
    5 discord://voxNXRuKscxYqg_0rqKvU4Vsl9-TNVXElA0B6Kgu5lmJEg3lyS65huuyQBlwhRQB9OEo@1288087265700220958
    6 discord://CTlgXETsDxsYzp1Gx43Ah-YoT45sUMJDH1uaCxQQgF7y5lMTBxsZ-j2zd9dd9FH82VVX@1288087396528947230
    7 discord://M7GyV8_Hs3EasuftTzg6exTOBufOlEPmBt6P4euXjdi0YXodoaOzxZeqTVWEpErXUx9r@1288087488652644412
    8 discord://Xcyqy9Po978SbT9TozhfaQVrVJoZTkBCRfT0ykwq2laS0UgYj1JMA-JYzsGPaI1wPDwc@1288087568797405265

    The URI format is discord://token@webhookid where token and webhookid are extracted from the webhook URL that Discord generates for you.

    https://discord.com/api/webhooks/webhookid/token
                                 ^^^^^^^^^ ^^^^^

  • Press Commit. The Provider will be applied to the cluster and will appear in the list of Providers

CLI method

Alternatively, applying the below resource creates the same discord provider.

You can copy the entire command in the 1st tab and paste it in the terminal of your VM.

kubectl apply -f - <<'EOF'
apiVersion: notifiers.eda.nokia.com/v1
kind: Provider
metadata:
  name: discord
spec:
  enabled: true
  uri: discord://yQeo_GQx3enCixFzlxE1UetZAUnSF9isl6rBfkBgb9vuurlgomstbhPpoyJryAMeLdby@1280864861592485900
EOF

apiVersion: notifiers.eda.nokia.com/v1
kind: Provider
metadata:
  name: discord
spec:
  enabled: true
  uri: discord://yQeo_GQx3enCixFzlxE1UetZAUnSF9isl6rBfkBgb9vuurlgomstbhPpoyJryAMeLdby@1280864861592485900

Define a simple Alarm notifier#

To create an alarm-based notifier:

  • Navigate to the Notifier resource category, select Notifier and press Create at the top right corner of the UI.
  • Fill in the Notifier form by giving the Notifier a name. For example - alarms-to-discord - since we will be sending alarms to a Discord channel.
  • Under Providers add an item and set it to discord. That's the name of provider created in the previous step.
  • Under Specification | Sources | Alarms, add an Include item and set it to *. That means include all alarms.
  • Press Commit. The Notifier will be applied to the cluster and will appear in the list of Notifiers
CLI method

Alternatively, applying the below resource creates the same alarm notifier.

You can copy the entire command in the 1st tab and paste it in the terminal of your VM.

kubectl apply -f - <<'EOF'
apiVersion: notifiers.eda.nokia.com/v1
kind: Notifier
metadata:
  name: alarms-to-discord
spec:
  description: "Notifier for all alarms to Discord"
  enabled: true
  sources:
    alarms:
      include:
        - "*"
  providers:
    - discord
EOF

apiVersion: notifiers.eda.nokia.com/v1
kind: Notifier
metadata:
  name: alarms-to-discord
spec:
  description: "Notifier for all alarms to Discord"
  enabled: true
  sources:
    alarms:
      include:
        - "*"
  providers:
    - discord

Test the notifier#

To test the notifier the easiest way is to trigger an alarm. For this lab we simply disable an interface.

  • Navigate to the resources category Topology and select Interfaces.
  • Double click on any interface you like and toggle the switch that says Enabled.
  • Press Commit at the button right of the form.
  • Check the notifications sent to the Discord Channel.
  • Enable back the interface. Check the notifications sent in the Channel.

Step2.2: Query-based notifier#

A query-based notifier leverages the full power of EDA Query Language, letting you precisely choose which objects and conditions trigger your notifications. You can also customize the notification’s title and body using templates, giving you complete control over the details.

We will define a notifier that gets triggered when a new LLDP neighbor is discovered and reuse the same Discord Provider defined in the previous step.

Configuring query-based notifier#

  • Navigate to the Notifier resource category, select Notifier and press Create at the top right corner of the UI.
  • Fill in the Notifier form by giving the Notifier a name. For example - new-lldp-neighbor - since we will be sending alarms to a Discord channel.
  • Under Providers add an item and set it to discord. That's the name of provider created in the previous step.

  • Under Specification | Sources | Query, set Table to

    .db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.status.members.neighbors

  • Add three Fields values in order for us to later use them in the message templates:

    • .db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name
    • interface
    • node

  • Set Title to

    LLDP neighbor - {{ index . ".db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name" }} -> {{ index . "node" }}-{{ index . "interface" }}

  • Set Template to

    A new LLDP neighbor has appeared on interface {{ index . ".db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name" }}: host name {{ index . "node" }}, interface name {{ index . "interface" }}

  • Press Commit. The Notifier will be applied to the cluster and will appear in the list of Notifiers

CLI method

Alternatively, applying the below resource creates the same query notifier.

You can copy the entire command in the 1st tab and paste it in the terminal of your VM.

kubectl apply -f - <<'EOF'
apiVersion: notifiers.eda.nokia.com/v1
kind: Notifier
metadata:
  name: new-lldp-neighbor
spec:
  description: "Notifier for new LLDP neighbors"
  enabled: true
  sources:
    query:
      table: .db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.status.members.neighbors
      fields:
      - .db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name
      - interface
      - node
      title: >-
        LLDP neighbor - 
        {{ index . ".db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name" }} 
        -> {{ index . "node" }}-{{ index . "interface" }}"
      template: >- 
        "A new LLDP neighbor has appeared on interface 
        {{ index . \".db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name\" }}: 
        host name {{ index . \"node\" }}, interface name {{ index . \"interface\" }}"
  providers:
  - discord
EOF

apiVersion: notifiers.eda.nokia.com/v1
kind: Notifier
metadata:
  name: new-lldp-neighbor
spec:
  description: "Notifier for new LLDP neighbors"
  enabled: true
  sources:
    query:
      table: .db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.status.members.neighbors
      fields:
      - .db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name
      - interface
      - node
      title: >-
        LLDP neighbor - 
        {{ index . ".db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name" }} 
        -> {{ index . "node" }}-{{ index . "interface" }}"
      template: >- 
        "A new LLDP neighbor has appeared on interface 
        {{ index . \".db.cr-status.interfaces_eda_nokia_com.v1alpha1.interface.name\" }}: 
        host name {{ index . \"node\" }}, interface name {{ index . \"interface\" }}"
  providers:
  - discord

Test the notifier#

To test the notifier we need to add/remove an LLDP neighbor. For this lab we simply disable an interface.

  • Navigate to the resources category Topology and select Interfaces.
  • Double click on an interface labeled eda.nokia.com/role=interSwitch and toggle the switch that says Enabled.
  • Press Commit at the button right of the form.
  • Check the notifications sent to the Discord Channel.
  • Enable back the interface. Check the notifications sent in the Channel.

Step3 (optional): Customize it#

Take it a step further by playing around with queries and templates to fine-tune your notifications. The Notifier app allows for deep customization, so you can craft notifications that perfectly suit your needs.

Hints:

  • BGP Neighbors state notifications:

    With the help of the Query page use the following query to build a BGP neighbor session state notifier .node.srl.network-instance.protocols.bgp.neighbor where (session-state != "established")

  • Get some inspiration from the queries used in Lab3.