Update notification-controller to v0.0.1

pull/79/head
stefanprodan 5 years ago
parent 789fd34c4a
commit ad655183e0

@ -24,6 +24,7 @@ jobs:
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/event.md > docs/components/notification/event.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/alert.md > docs/components/notification/alert.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/provider.md > docs/components/notification/provider.md
curl https://raw.githubusercontent.com/fluxcd/notification-controller/master/docs/spec/v1alpha1/receiver.md > docs/components/notification/receiver.md
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:

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.
![](../../_files/notification-controller.png)
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).

@ -1,5 +1,5 @@
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
- github.com/fluxcd/notification-controller/config//crd?ref=v0.0.1-beta.1
- github.com/fluxcd/notification-controller/config//manager?ref=v0.0.1-beta.1
- github.com/fluxcd/notification-controller/config//crd?ref=v0.0.1
- github.com/fluxcd/notification-controller/config//manager?ref=v0.0.1

@ -56,6 +56,7 @@ nav:
- Provider CRD: components/notification/provider.md
- Alert CRD: components/notification/alert.md
- Event: components/notification/event.md
- Webhook Receiver: components/notification/receiver.md
- Notification API Reference: components/notification/api.md
- Toolkit CLI:
- Overview: cmd/tk.md

Loading…
Cancel
Save