[FEATURE] Autogenerate SMTP configuration for Grafana

Author: gsmith-sas

CHANGELOG.md

@@ -10,6 +10,12 @@
   * [UPGRADE] Fluent Bit Helm chart upgraded from 0.49.0 to 0.52.0
   * [UPGRADE] Elasticsearch Exporer Helm chart upgraded from 6.7.2 to 7.0.0
   * [UPGRADE] OpenSearch Data Source Plugin to Grafana upgraded from 2.28.0 to 2.29.1
+* **Metrics**
+  * [FEATURE] Automatically define the SMTP server configuration to permit Grafana to send e-mails.
+If enabled (by setting AUTOGENERATE_SMTP to 'true'), this optional feature allows admins to define
+email-based contact points for alerts. Users need to provide connection information via the environment 
+variables: SMTP_SERVER, SMTP_PORT, SMTP_FROM_ADDRESS and SMTP_FROM_NAME.  See Autogenerate SMTP Configuration
+for more information.
 
 
 ## Version 1.2.41 (19AUG2025)

bin/autogenerate-include.sh

@@ -46,8 +46,9 @@ export -f create_ingress_certs
 
 AUTOGENERATE_INGRESS="${AUTOGENERATE_INGRESS:-false}"
 AUTOGENERATE_STORAGECLASS="${AUTOGENERATE_STORAGECLASS:-false}"
+AUTOGENERATE_SMTP="${AUTOGENERATE_SMTP:-false}"
 
-if [ "$AUTOGENERATE_INGRESS" != "true" ] && [ "$AUTOGENERATE_STORAGECLASS" != "true" ]; then
+if [ "$AUTOGENERATE_INGRESS" != "true" ] && [ "$AUTOGENERATE_STORAGECLASS" != "true" ] && [ "$AUTOGENERATE_SMTP" != "true" ]; then
     log_debug "No autogeneration of YAML enabled"
     export AUTOGENERATE_SOURCED="NotNeeded"
 fi
@@ -69,7 +70,6 @@ if [ -z "$AUTOGENERATE_SOURCED" ]; then
             exit 1
         fi
 
-
         #validate required inputs
         BASE_DOMAIN="${BASE_DOMAIN}"
         if [ -z "$BASE_DOMAIN" ]; then
@@ -107,8 +107,66 @@ if [ -z "$AUTOGENERATE_SOURCED" ]; then
     fi
 
     if [ "$AUTOGENERATE_STORAGECLASS" == "true" ]; then
-
         log_info "Autogeneration of StorageClass specfication has been enabled"
+    fi
+
+    if [ "$AUTOGENERATE_SMTP" == "true" ]; then
+
+        #required
+        # shellcheck disable=SC2269
+        SMTP_HOST="${SMTP_HOST}"
+        # shellcheck disable=SC2269
+        SMTP_PORT="${SMTP_PORT}"
+        # shellcheck disable=SC2269
+        SMTP_FROM_ADDRESS="${SMTP_FROM_ADDRESS}"
+        # shellcheck disable=SC2269
+        SMTP_FROM_NAME="${SMTP_FROM_NAME}"
+
+        #optional
+        # shellcheck disable=SC2269
+        SMTP_USER="${SMTP_USER}"
+        # shellcheck disable=SC2269
+        SMTP_PASSWORD="${SMTP_PASSWORD}"
+        SMTP_USER_SECRET="${SMTP_USER_SECRET:-grafana-smtp-user}"
+        SMTP_SKIP_VERIFY="${SMTP_SKIP_VERIFY:-false}"
+        SMTP_TLS_CERT_FILE="${SMTP_TLS_CERT_FILE:-/cert/tls.crt}"
+        SMTP_TLS_KEY_FILE="${SMTP_TLS_KEY_FILE:-/cert/tls.key}"
+
+        log_info "Autogeneration of SMTP Configuration has been enabled"
+
+        if [ -z "$SMTP_HOST" ]; then
+            log_error "Required parameter [SMTP_HOST] not provided"
+            exit 1
+        fi
+
+        if [ -z "$SMTP_PORT" ]; then
+            log_error "Required parameter [SMTP_PORT] not provided"
+            exit 1
+        fi
+
+        if [ -z "$SMTP_FROM_ADDRESS" ]; then
+            log_error "Required parameter [SMTP_FROM_ADDRESS] not provided"
+            exit 1
+        fi
+
+        if [ -z "$SMTP_FROM_NAME" ]; then
+            log_error "Required parameter [SMTP_FROM_NAME] not provided"
+            exit 1
+        fi
+
+        # Handle SMTP user credentials
+        if [ -n "$(kubectl get secret -n "$MON_NS" "$SMTP_USER_SECRET" --ignore-not-found -o name 2> /dev/null)" ]; then
+            log_debug "Secret [$SMTP_USER_SECRET] exists; will use it for SMTP user credentials"
+        elif [ -z "$SMTP_USER" ] && [ -z "$SMTP_PASSWORD" ]; then
+            log_debug "Neither SMTP_USER nor SMTP_PASSWORD are set; skipping creation of secret [$SMTP_USER_SECRET]"
+        elif  [ -z "$SMTP_USER" ] || [ -z "$SMTP_PASSWORD" ]; then
+            log_error "Complete SMTP Credentials NOT provided; MUST provide BOTH [SMTP_USER] and [SMTP_PASSWORD]"
+            log_info "SMTP_USER is set to [$SMTP_USER] and SMTP_PASSWORD is set to [$SMTP_PASSWORD]"
+            exit 1
+        else
+            log_debug "Creating secret [$MON_NS/$SMTP_USER_SECRET] from supplied user [$SMTP_USER] and password."
+            kubectl create secret generic "$SMTP_USER_SECRET" -n "$MON_NS" --from-literal=user="$SMTP_USER" --from-literal=password="$SMTP_PASSWORD"
+        fi
 
     fi
 

monitoring/bin/deploy_monitoring_cluster.sh

@@ -59,6 +59,55 @@ else
     log_debug "Autogeneration of storageClassReferences NOT enabled"
 fi
 
+AUTOGENERATE_SMTP="${AUTOGENERATE_SMTP:-false}"
+
+if [ "$AUTOGENERATE_SMTP" == "true" ]; then
+
+    if [ ! -f "$autogeneratedYAMLFile" ]; then
+        log_debug "Creating file [$autogeneratedYAMLFile]"
+        touch "$autogeneratedYAMLFile"
+    else
+        log_debug "File [$autogeneratedYAMLFile] already exists"
+    fi
+
+   smtpHost="${SMTP_HOST}"
+   smtpPort="${SMTP_PORT}"
+   smtpFromAddress="${SMTP_FROM_ADDRESS}"
+   smtpFromName="${SMTP_FROM_NAME}"
+   smtpUserSecret="${SMTP_USER_SECRET}"
+   smtpSkipVerify="${SMTP_SKIP_VERIFY:-false}"
+   smtpTLSCertFile="${SMTP_TLS_CERT_FILE:-/cert/tls.crt}"
+   smtpTLSKeyFile="${SMTP_TLS_KEY_FILE:-/cert/tls.key}"
+   ###smtpTLSSecret="${SMTP_TLS_REQUIRED}"
+
+   yq -i '.grafana."grafana.ini".smtp.enabled=true' "$autogeneratedYAMLFile"
+
+   value="$smtpHost:$smtpPort" yq -i '.grafana."grafana.ini".smtp.host=env(value)' "$autogeneratedYAMLFile"
+
+   value="$smtpFromAddress" yq -i '.grafana."grafana.ini".smtp.from_address=env(value)' "$autogeneratedYAMLFile"
+   value="$smtpFromName" yq -i '.grafana."grafana.ini".smtp.from_name=env(value)' "$autogeneratedYAMLFile"
+
+   if [ -n "$smtpUserSecret" ]; then
+       value="$smtpUserSecret" yq -i '.grafana.smtp.existingSecret=env(value)' "$autogeneratedYAMLFile"
+   fi
+
+   value="$smtpSkipVerify" yq -i '.grafana."grafana.ini".smtp.skip_verify=env(value)' "$autogeneratedYAMLFile"
+
+   value="$smtpTLSCertFile" yq -i '.grafana."grafana.ini".smtp.cert_file=env(value)' "$autogeneratedYAMLFile"
+   value="$smtpTLSKeyFile" yq -i '.grafana."grafana.ini".smtp.key_file=env(value)' "$autogeneratedYAMLFile"
+
+#    if [ -n "$smtpUser" ]; then
+#        value="$smtpUser" yq -i '.grafana."grafana.ini".smtp.user=env(value)' "$autogeneratedYAMLFile"
+#    fi
+#    if [ -n "$smtpPassword" ]; then
+#        value="$smtpPassword" yq -i '.grafana."grafana.ini".smtp.password=env(value)' "$autogeneratedYAMLFile"
+#    fi
+
+else
+    log_debug "Auto-generation of SMTP not enabled; skipping Grafana SMTP server configuration"
+fi
+
+
 PROM_OPER_USER_YAML="${PROM_OPER_USER_YAML:-$USER_DIR/monitoring/user-values-prom-operator.yaml}"
 if [ ! -f "$PROM_OPER_USER_YAML" ]; then
     log_debug "[$PROM_OPER_USER_YAML] not found. Using $TMP_DIR/empty.yaml"