Skip to main content

Notification Domain

The Notification domain handles the creation, formatting, and delivery of notifications within the Control Plane. It supports multiple delivery channels and uses admin-defined templates so that notification content can be customized without changing application code.

Custom Resources​

Notification​

Notification is the Schema for the notifications API

Group: notification.cp.ei.telekom.de · Version: v1 · Scope: Namespaced

NotificationSpec​

Appears in: Notification

spec defines the desired state of Notification

FieldTypeDefaultValidation
channelsChannels[]—Optional
propertiesobject—Optional
purposestring—Required, minLength: 1, maxLength: 63
senderSender—Required

Channels​

Appears in: NotificationSpec

Channels defines the channels to send the notification to.

FieldTypeDefaultValidation
namestring—Required
namespacestring—Required
uidstring—Optional

Sender​

Appears in: NotificationSpec

Sender contains the information about the entity that is sending the notification

FieldTypeDefaultValidation
namestring—Required, minLength: 1, maxLength: 63
typestring—Required, Enum: User \| System

NotificationStatus​

Appears in: Notification

status defines the observed state of Notification

FieldTypeDefaultValidation
conditionsCondition[]—Optional
statesmap<string, object>—Optional

Condition​

Appears in: NotificationStatus, NotificationChannelStatus

Conditions represent the latest available observations of the Rover's state

FieldTypeDefaultValidation
lastTransitionTimestring—Required, Format: date-time
messagestring—Required, maxLength: 32768
observedGenerationinteger—Optional, Format: int64, minimum: 0
reasonstring—Required, minLength: 1, maxLength: 1024, pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
statusstring—Required, Enum: True \| False \| Unknown
typestring—Required, maxLength: 316, pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$

NotificationChannel​

NotificationChannel is the Schema for the notificationchannels API

Group: notification.cp.ei.telekom.de · Version: v1 · Scope: Namespaced

NotificationChannelSpec​

Appears in: NotificationChannel

spec defines the desired state of NotificationChannel

FieldTypeDefaultValidation
emailEmail—Optional
ignorestring[]—Optional, maxItems: 100
msTeamsMsTeams—Optional
webhookWebhook—Optional

Email​

Appears in: NotificationChannelSpec

Mail configuration, required if Type is Mail

FieldTypeDefaultValidation
authenticationAuthentication—Optional
fromstring—Optional, Format: email
recipientsstring[]—Required

Authentication​

Appears in: Email, MsTeams, Webhook

Authentication configuration

FieldTypeDefaultValidation
noneobject—Optional
oauth2Oauth2—Optional

Oauth2​

Appears in: Authentication

FieldTypeDefaultValidation
clientIdstring—Required
clientSecretstring—Required
scopesstring[]—Optional
tokenUrlstring—Required, pattern: ^https?://[^\s/$.?#].[^\s]*$

MsTeams​

Appears in: NotificationChannelSpec

Chat configuration, required if Type is Chat

FieldTypeDefaultValidation
authenticationAuthentication—Optional
webhookUrlstring—Required, Format: uri

Webhook​

Appears in: NotificationChannelSpec

Callback configuration, required if Type is Callback

FieldTypeDefaultValidation
authenticationAuthentication—Optional
headersmap<string, string>—Optional
methodstringPOSTRequired, Enum: POST
urlstring—Required, pattern: ^https?://[^\s/$.?#].[^\s]*$

NotificationChannelStatus​

Appears in: NotificationChannel, NotificationTemplate

status defines the observed state of NotificationChannel

FieldTypeDefaultValidation
conditionsCondition[]—Optional

NotificationTemplate​

NotificationTemplate is the Schema for the notificationtemplates API

Group: notification.cp.ei.telekom.de · Version: v1 · Scope: Namespaced

NotificationTemplateSpec​

Appears in: NotificationTemplate

spec defines the desired state of NotificationTemplate

FieldTypeDefaultValidation
attachmentsAttachments[]—Optional
channelTypestring—Required, Enum: Email \| MsTeams \| Webhook
purposestring—Required, minLength: 1, maxLength: 63
schemaobject—Optional
subjectTemplatestring—Optional
templatestring—Required

Attachments​

Appears in: NotificationTemplateSpec

Attachments defines file attachments to include when sending this notification. Each attachment is rendered as a Go template against the notification properties.

FieldTypeDefaultValidation
contentTypestring—Required, minLength: 1
filenamestring—Required, minLength: 1
templatestring—Required, minLength: 1

Domain Interactions​

  • Organization domain — Automatically creates a NotificationChannel for each team.
  • Approval domain — Creates Notification resources for approval lifecycle events.
  • All domains — Any domain can trigger notifications by creating Notification resources.