Skip to content
HomeConfigurationNotification Channels

Notification Channels ​

Notification Channels let KubeOsprey push Change Plan lifecycle events to your team's chat tools. Administrators configure channels in Settings → Notification Channels; each channel subscribes to the events it cares about.

Notification channels settings page

Supported channel types ​

TypeProtocolNotes
dingtalkDingTalk group robot, Markdown payloadOptional HMAC-SHA256 signing via secret
wecomWeCom (企业微信) group bot, Markdown payloadMessages longer than 4096 bytes are truncated
feishuFeishu (Lark) bot, text payloadOptional timestamp-based signing via secret
slackSlack incoming webhook, {"text": ...}
webhookGeneric receiver, JSON {"title": ..., "text": ...}Point it at any HTTP endpoint

Events ​

EventMeaning
plan_pendingA change plan is awaiting approval
plan_appliedA change plan finished successfully
plan_failedA change plan finished with failures
alert_firingA cluster alert started firing
event_warningA new kubernetes warning event appeared

Each channel stores its subscribed events as a comma-separated list, so one channel can receive several event kinds.

Cluster alerts and warning events ​

KubeOsprey polls every connected cluster once a minute and pushes newly observed Alertmanager alerts (alert_firing) and kubernetes warning events (event_warning) to the subscribed channels.

  • Only new alerts and events are delivered. The first poll after a restart records the current state without notifying, so a fresh deployment does not replay everything already firing.
  • Silenced alerts are not delivered — silencing means exactly that.
  • Repeated warning events notify once per event lifecycle, not once per occurrence.
  • Polling only runs when at least one enabled channel subscribes to these two event kinds.

Channel fields ​

  • Name — unique identifier of the channel.
  • Type — one of the types above.
  • Endpoint — the webhook URL of the receiver.
  • Secret — signing secret for DingTalk/Feishu; stored encrypted with KUBE_OSPREY_ENCRYPT_KEY and never returned by the API.
  • Events — subscribed event kinds.
  • Enabled — disabled channels stop receiving deliveries.

KubeOsprey records the delivery result of the last dispatch per channel (success/failure, error message, timestamp), so a misconfigured channel is visible in the settings list instead of silently dropping messages.

Testing a channel ​

Use the Test button in the settings UI, or call the API directly, to send a sample message and verify the endpoint and signing configuration:

bash
POST /api/v1/admin/notifications/channels/:id/test

API ​

All endpoints require administrator access:

MethodPathPurpose
GET/api/v1/admin/notifications/channelsList channels
POST/api/v1/admin/notifications/channelsCreate a channel
PUT/api/v1/admin/notifications/channels/:idUpdate a channel
DELETE/api/v1/admin/notifications/channels/:idDelete a channel
POST/api/v1/admin/notifications/channels/:id/testSend a test notification

See Change Plans for the workflow these notifications belong to.

Released under the Apache License.