Mirrors/flux2
1
0
Fork 0
mirror of synced 2026-02-13 21:16:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update notification-controller to v0.0.1

Browse Source
This commit is contained in:
stefanprodan
2020-07-07 10:03:34 +03:00
parent 789fd34c4a
commit ad655183e0
7 changed files with 16 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/docs.yaml vendored
View File

@@ -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/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/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/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 - name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master uses: mhausenblas/mkdocs-deploy-gh-pages@master
env: env:

BIN
docs/_files/notification-controller.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 43 KiB

15
docs/components/notification/controller.md
View File

@@ -1,14 +1,15 @@
# Notification Controller # Notification Controller
The Notification Controller is a Kubernetes operator, The Notification Controller is a Kubernetes operator, specialized in handling inbound and outbound events.
specialized in dispatching events to external systems such as
Slack, Microsoft Teams, Discord and Rocket chat.
The controller receives events via HTTP and dispatch them to external ![](../../_files/notification-controller.png)
webhooks based on event severity and involved objects.
The controller can be configured with Kubernetes custom resources that The controller handles events coming from external systems (GitHub, GitLab, Bitbucket, Harbour, Jenkins, etc)
define how events are processed and where to dispatch them. 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: Links:

4
docs/guides/notifications.md
View File

@@ -42,9 +42,9 @@ spec:
name: slack-url 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. [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 This way you can create custom handlers that can store the events in
Elasticsearch, CloudWatch, Stackdriver, etc. Elasticsearch, CloudWatch, Stackdriver, etc.

3
docs/index.md
View File

@@ -29,7 +29,7 @@ Target features:
- External events handling (webhook receivers) - External events handling (webhook receivers)
- Source write-back (automated patching) - Source write-back (automated patching)
- Policy driven validation (OPA, admission controllers) - 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 workflow providers (GitHub Actions, Tekton, Argo)
- Interoperability with CAPI providers - Interoperability with CAPI providers
@@ -44,6 +44,7 @@ Components:
- [Notification Controller](components/notification/controller.md) - [Notification Controller](components/notification/controller.md)
- [Provider CRD](components/notification/provider.md) - [Provider CRD](components/notification/provider.md)
- [Alert CRD](components/notification/alert.md) - [Alert CRD](components/notification/alert.md)
- [Receiver CRD](components/notification/receiver.md)
- Helm Controller (TBA) - Helm Controller (TBA)
To get started with the toolkit please follow this [guide](get-started/index.md). To get started with the toolkit please follow this [guide](get-started/index.md).

4
manifests/bases/notification-controller/kustomization.yaml
View File

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

1
mkdocs.yml
View File

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