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
propertiesobjectOptional
purposestringRequired, minLength: 1, maxLength: 63
senderSenderRequired

Channels

Appears in: NotificationSpec

Channels defines the channels to send the notification to.

FieldTypeDefaultValidation
namestringRequired
namespacestringRequired
uidstringOptional

Sender

Appears in: NotificationSpec

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

FieldTypeDefaultValidation
namestringRequired, minLength: 1, maxLength: 63
typestringRequired, 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
lastTransitionTimestringRequired, Format: date-time
messagestringRequired, maxLength: 32768
observedGenerationintegerOptional, Format: int64, minimum: 0
reasonstringRequired, minLength: 1, maxLength: 1024, pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
statusstringRequired, Enum: True \| False \| Unknown
typestringRequired, 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
emailEmailOptional
ignorestring[]Optional, maxItems: 100
msTeamsMsTeamsOptional
webhookWebhookOptional

Email

Appears in: NotificationChannelSpec

Mail configuration, required if Type is Mail

FieldTypeDefaultValidation
authenticationAuthenticationOptional
fromstringOptional, Format: email
recipientsstring[]Required

Authentication

Appears in: Email, MsTeams, Webhook

Authentication configuration

FieldTypeDefaultValidation
noneobjectOptional
oauth2Oauth2Optional

Oauth2

Appears in: Authentication

FieldTypeDefaultValidation
clientIdstringRequired
clientSecretstringRequired
scopesstring[]Optional
tokenUrlstringRequired, pattern: ^https?://[^\s/$.?#].[^\s]*$

MsTeams

Appears in: NotificationChannelSpec

Chat configuration, required if Type is Chat

FieldTypeDefaultValidation
authenticationAuthenticationOptional
webhookUrlstringRequired, Format: uri

Webhook

Appears in: NotificationChannelSpec

Callback configuration, required if Type is Callback

FieldTypeDefaultValidation
authenticationAuthenticationOptional
headersmap<string, string>Optional
methodstringPOSTRequired, Enum: POST
urlstringRequired, 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
channelTypestringRequired, Enum: Email \| MsTeams \| Webhook
purposestringRequired, minLength: 1, maxLength: 63
schemaobjectOptional
subjectTemplatestringOptional
templatestringRequired

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.