Update notification-controller to v0.0.1
This commit is contained in:
BIN
docs/_files/notification-controller.png
Normal file
BIN
docs/_files/notification-controller.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 43 KiB |
@@ -1,14 +1,15 @@
|
||||
# Notification Controller
|
||||
|
||||
The Notification Controller is a Kubernetes operator,
|
||||
specialized in dispatching events to external systems such as
|
||||
Slack, Microsoft Teams, Discord and Rocket chat.
|
||||
The Notification Controller is a Kubernetes operator, specialized in handling inbound and outbound events.
|
||||
|
||||
The controller receives events via HTTP and dispatch them to external
|
||||
webhooks based on event severity and involved objects.
|
||||

|
||||
|
||||
The controller can be configured with Kubernetes custom resources that
|
||||
define how events are processed and where to dispatch them.
|
||||
The controller handles events coming from external systems (GitHub, GitLab, Bitbucket, Harbour, Jenkins, etc)
|
||||
and notifies the GitOps toolkit controllers about source changes.
|
||||
|
||||
The controller handles events emitted by the GitOps toolkit controllers (source, kustomize, helm)
|
||||
and dispatches them to external systems (Slack, Microsoft Teams, Discord, Rocker)
|
||||
based on event severity and involved objects.
|
||||
|
||||
Links:
|
||||
|
||||
|
||||
@@ -42,9 +42,9 @@ spec:
|
||||
name: slack-url
|
||||
```
|
||||
|
||||
The provider type can be `slack`, `msteams`, `discord`, `rocket` or `webhook`.
|
||||
The provider type can be `slack`, `msteams`, `discord`, `rocket` or `generic`.
|
||||
|
||||
When type `webhook` is specified, the notification controller will post the incoming
|
||||
When type `generic` is specified, the notification controller will post the incoming
|
||||
[event](../components/notification/event.md) in JSON format to the webhook address.
|
||||
This way you can create custom handlers that can store the events in
|
||||
Elasticsearch, CloudWatch, Stackdriver, etc.
|
||||
|
||||
@@ -29,7 +29,7 @@ Target features:
|
||||
- External events handling (webhook receivers)
|
||||
- Source write-back (automated patching)
|
||||
- Policy driven validation (OPA, admission controllers)
|
||||
- Seamless integration with Git providers (GitHub, GitLab, BitBucket)
|
||||
- Seamless integration with Git providers (GitHub, GitLab, Bitbucket)
|
||||
- Interoperability with workflow providers (GitHub Actions, Tekton, Argo)
|
||||
- Interoperability with CAPI providers
|
||||
|
||||
@@ -44,6 +44,7 @@ Components:
|
||||
- [Notification Controller](components/notification/controller.md)
|
||||
- [Provider CRD](components/notification/provider.md)
|
||||
- [Alert CRD](components/notification/alert.md)
|
||||
- [Receiver CRD](components/notification/receiver.md)
|
||||
- Helm Controller (TBA)
|
||||
|
||||
To get started with the toolkit please follow this [guide](get-started/index.md).
|
||||
|
||||
Reference in New Issue
Block a user