ObservabilityAlertsNotificationChannel

An ObservabilityAlertsNotificationChannel defines a destination for alert notifications. These resources are environment-bound, meaning each channel is associated with a specific OpenChoreo environment.

Default Notification Channel

In each environment, one ObservabilityAlertsNotificationChannel can be marked as the default. The first notification channel created in an environment is automatically marked as the default channel. If an ObservabilityAlertRule is created without explicitly specifying actions.notifications.channels, it will automatically use the default channel for that environment.

Currently, email and webhook notifications are supported.

API Version

openchoreo.dev/v1alpha1

Resource Definition

Metadata

ObservabilityAlertsNotificationChannel resources are namespace-scoped.

apiVersion: openchoreo.dev/v1alpha1
kind: ObservabilityAlertsNotificationChannel
metadata:
  name: <channel-name>
  namespace: <org-namespace>

Spec Fields

Field	Type	Required	Description
environment	string	Yes	Name of the OpenChoreo environment this channel belongs to (Immutable)
isEnvDefault	boolean	No	If true, this is the default channel for the environment. Default channels are used by alert rules that don't specify a channel. Defaults to false. First channel created in an environment will be marked as the default
type	NotificationChannelType	Yes	The type of notification channel (email or webhook)
emailConfig	EmailConfig	Required if type is email	Email configuration
webhookConfig	WebhookConfig	Required if type is webhook	Webhook configuration

NotificationChannelType

Value	Description
email	Email notification channel
webhook	HTTP webhook notification channel

EmailConfig

Field	Type	Required	Description
from	string	Yes	The sender email address
to	string[]	Yes	List of recipient email addresses (minimum 1)
smtp	SMTPConfig	Yes	SMTP server configuration
template	EmailTemplate	Yes	Email subject and body templates using CEL expressions

WebhookConfig

Field	Type	Required	Description
url	string	Yes	The webhook endpoint URL where alerts will be sent (must be a valid URI)
headers	map[string]WebhookHeaderValue	No	Optional HTTP headers to include in the webhook request. Each header value can be provided inline or via a secret reference.
payloadTemplate	string	No	Optional JSON payload template using CEL expressions. If not provided, the raw alertDetails object will be sent as JSON. CEL expressions use ${...} syntax and have access to alert fields: ${alertName}, ${alertDescription}, ${alertSeverity}, ${alertValue}, etc. Example for Slack: {"text": "Alert: ${alertName}", "blocks": [...]}

WebhookHeaderValue

Defines a header value that can be provided inline or via a secret reference.

Mutually Exclusive Fields

Exactly one of value or valueFrom must be set (not both, not neither).

Field	Type	Required	Description
value	string	No	Inline header value (mutually exclusive with valueFrom)
valueFrom	SecretValueFrom	No	Reference to a secret containing the header value (mutually exclusive with value)

SMTPConfig

Field	Type	Required	Description
host	string	Yes	SMTP server hostname
port	integer	Yes	SMTP server port
auth	SMTPAuth	Yes	SMTP authentication credentials
tls	SMTPTLSConfig	Yes	TLS configuration for SMTP

SMTPAuth

Field	Type	Required	Description
username	SecretValueFrom	Yes	Username for SMTP authentication (inline or secret ref)
password	SecretValueFrom	Yes	Password for SMTP authentication (inline or secret ref)

SMTPTLSConfig

Field	Type	Required	Description
insecureSkipVerify	boolean	No	If true, skips TLS certificate verification (not recommended for production)

EmailTemplate

Defines the email template using CEL expressions.

Field	Type	Required	Description
subject	string	Yes	CEL expression for the email subject (e.g., "[${alert.severity}] - ${alert.name} Triggered")
body	string	Yes	CEL expression for the email body

SecretValueFrom

Defines how to obtain a secret value.

Field	Type	Required	Description
secretKeyRef	SecretKeyRef	No	Reference to a key in a Kubernetes secret

SecretKeyRef

Field	Type	Required	Description
name	string	Yes	Name of the secret
namespace	string	Yes	Namespace of the secret
key	string	Yes	Key within the secret

Examples

Email Notification Channel

apiVersion: openchoreo.dev/v1alpha1
kind: ObservabilityAlertsNotificationChannel
metadata:
  name: prod-email-notifications
  namespace: my-org
spec:
  environment: production
  isEnvDefault: true
  type: email
  emailConfig:
    from: "alerts@example.com"
    to:
      - "admin@example.com"
      - "devops@example.com"
    smtp:
      host: "smtp.example.com"
      port: 587
      auth:
        username:
          secretKeyRef:
            name: smtp-credentials
            key: username
        password:
          secretKeyRef:
            name: smtp-credentials
            key: password
      tls:
        insecureSkipVerify: false
    template:
      subject: "[OpenChoreo] ${alert.severity}: ${alert.name}"
      body: "Alert ${alert.name} triggered at ${alert.startsAt}.\n\nDescription: ${alert.description}"

Webhook Notification Channel

apiVersion: openchoreo.dev/v1alpha1
kind: ObservabilityAlertsNotificationChannel
metadata:
  name: prod-webhook-notifications
  namespace: my-org
spec:
  environment: production
  isEnvDefault: false
  type: webhook
  webhookConfig:
    url: https://alerts.example.com/webhook
    headers:
      X-OpenChoreo-Source:
        value: observer
      Authorization:
        valueFrom:
          secretKeyRef:
            name: webhook-token
            key: token
    payloadTemplate: |
      {
        "text": "Alert: ${alertName}",
        "severity": "${alertSeverity}",
        "description": "${alertDescription}",
        "value": "${alertValue}"
      }

Related Resources

• ObservabilityAlertRule - Rules that trigger notifications to these channels
• Environment - Notification channels are environment-specific
• ObservabilityPlane - Provides the underlying observability infrastructure
• ClusterObservabilityPlane - Provides the underlying observability infrastructure for cluster-scoped resources