[BUG-NOK] Open Edge Orchestrator - Email Alerts not configurable

[amathan]

Bug Description

A service admin is not able to see any users / email Id's under Email Alerts to configure

Expected:

Actual:

User Groups

System Setup

AWS based Orchestrator v3.1.2

Reproducible Steps

1. In keycloak for a user assign respective project groups and service admin group
2. Login from the web-ui
3. Select settings->Alerts->Email Alerts
4. No email Ids are listed to configure

Ref: https://docs.openedgeplatform.intel.com/edge-manage-docs/3.1/user_guide/administration/alerts_email.html

Root Cause Analysis

No response

[jgespino]

@amathan Seems like you have the correct group memberships and should see the email ids. I just checked on my EMF 3.1.2 onprem deployment and I do see the email ids. @scottmbaker Do you have any input?

[sunil-parida]

Hi @amathan The email alert profile needs to be enabled to receive mail notifications.

Override via cluster.yaml:
SMTP configuration can also be overridden in the following profile file:

orch-configs/profiles/alerting-emails.yaml

Make sure the EMAIL profile is enabled. Example configuration:

smtp:
insecureSkipVerify: true

create mailpit server:

You can also test using the Mailpit server:
http://mailpit-server-ip:8025/

---

For On-Prem Deployment:
Before running the deployment, make sure the following environment variables are set:

export SMTP_ADDRESS=mailpit-server-ip
export SMTP_PORT=587
export SMTP_HEADER="foo bar foo@bar.com"
export SMTP_USERNAME=""
export SMTP_PASSWORD=""

---

For AWS Deployment:
Use the following Terraform variables to configure SMTP:

export TF_VAR_smtp_url="mailpit-server-ip"
export TF_VAR_smtp_port=587
export TF_VAR_smtp_from="foo bar foo@bar.com"
export TF_VAR_smtp_user=
export TF_VAR_smtp_pass=""

[amathan]

@sunil-parida The SMTP configuration I believe is second part of the feature which will help in pushing out emails to the configured users.
The problem here is I am not able to see the list of emails which can be chosen as per this document to configure. (https://docs.openedgeplatform.intel.com/edge-manage-docs/3.1/user_guide/administration/alerts_email.html)

Or is it like only when SMTP server is configured during the deployment the emails itself can be chosen / configured?

[sunil-parida]

@amathan To view this email ID list, we need to fill users with email configuration.
While creating a new user, please ensure that the following details are filled in:

Username
Email ID
First Name
Last Name

Additionally, make sure to add the user to the following groups:

Project Manager Group
Service Admin Group

Alert email notification after EN onboard ,

[amathan]

@sunil-parida the same steps to create user and assign groups were followed as documented in description.
Note: Assigning the user to a Project Manager group is not there in document https://docs.openedgeplatform.intel.com/edge-manage-docs/3.1/user_guide/administration/alerts_email.html

Below is the screen shot for new user creation and assignment of suggested groups (Project Manager, service admin)

[sunil-parida]

@amathan Yes, the Project Manager group is not required.

Can you please verify the email alert using the steps mentioned below?

If it doesn’t work, we can schedule a debug call.

=========================================
Enabling Email Alerts During AWS ORCH Deployment

This document describes the steps required to enable and verify SMTP (email) configuration during the ORCH deployment process.

---

1. SMTP Configuration During Deployment

---

During the execution of utils/provision.sh config, the script will prompt you to review and confirm SMTP-related settings.

Example file path for SMTP parameters:

::

/root/pod-configs/SAVEME/<AWS-ACCOUNT>-<BUCKET>-values.tfvar

Example SMTP Parameters:

.. code-block:: bash

# The email configuration information
smtp_user="root"
smtp_pass="root123"
smtp_url="xx.xx.xx.xx"
smtp_port=587
smtp_from="emailtest orch <email@test.com>"

Notes:

• Ensure that all SMTP parameters are filled in before proceeding.
• Verify that the SMTP host and port are reachable from your environment.

---

2. Review and Overwrite SMTP Settings in Email Alert Profile

---

When you run configure-cluster.sh, the system generates a <clustername>.yaml file.

During this step, you will be prompted to review the configuration.

If your email server does not require user login, TLS, or certificate verification, overwrite the email section as shown below.

Note:
Currently, the email alert feature has been validated with servers that do not require user login and TLS certificate verification.

.. code-block:: yaml

argo:
  o11y:
    alertingMonitor:
      smtp:
        userPasswordAuth: false
        requireTls: false
        insecureSkipVerify: true

Alternative Option:

You can manually edit the alerting-emails.yaml file before running configure-cluster.sh to apply the same settings.

Example edited file:

.. code-block:: yaml

argo:
  o11y:
    alertingMonitor:
      smtp:
        initialize: true
        configSecret: smtp
        userPasswordAuth: false
        passwordSecret:
          name: smtp-auth
          key: password
        requireTls: false
        insecureSkipVerify: true

Additional Notes:

• Verify that your cluster.yaml file includes the email profile from:

  orch-configs/profiles/alerting-emails.yaml

• After running configure-cluster.sh, review your cluster configuration at:

  ~/src/edge-manageability-framework/orch-configs/clusters/<clustername>.yaml

Once the ORCH deployment is complete, proceed to add users in Keycloak as described below.

To verify your SMTP configuration after deployment, run:

.. code-block:: bash

kubectl get secret smtp -n orch-infra -o yaml

---

3. Configuring Users for Email Alerts (Keycloak)

---

To view and manage the email ID list for alert notifications, ensure that users are correctly created in Keycloak with valid email information.

Required User Details:

• Username
• Email ID
• First Name
• Last Name

Join user Group Membership:

• Add the user to the Service Admin Group

``

[ss5829]

@sunil-parida ,

please note the steps mentioned above were performed during an instance deployment,

corresponding changes were done in Keycloak too.

still, following is the output seen in the Email Alerts config. page,

CC: @amathan

[ss5829]

for ONPREM, it required few SMTP & DNS config. to be done

kubectl rollout restart deployment -n kube-system rke2-coredns-rke2-coredns
kubectl edit configmap rke2-coredns-rke2-coredns -n kube-system -o yaml

       hosts {
       _IP.IP.IP.IP_ keycloak.cluster.onprem
       fallthrough
       }

[ss5829]

the user Email Ids can now be configured.

however it takes time, more than 3 hours, yet this Deployment status error alert has not reached the INBOX (Junk folder is empty too)

CC: @amathan