Skip to content

Commit

Permalink
Merge pull request #95 from fluxcd/docs/helm-controller-notifications
Browse files Browse the repository at this point in the history
Document helm-controller notifications in guide
  • Loading branch information
stefanprodan committed Jul 16, 2020
2 parents 32adbf2 + 06906eb commit 116d53a
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
Binary file added docs/diagrams/helm-controller-alerts.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
36 changes: 35 additions & 1 deletion docs/guides/helmreleases.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Managing Helm releases
# Manage Helm releases

The [helm-controller](../components/helm/controller.md) allows you to
declaratively manage Helm chart releases with Kubernetes manifests.
Expand Down Expand Up @@ -92,3 +92,37 @@ helm-controller.
for finer grain control over how Helm actions are performed.
See the [`HelmRelease` CRD docs](../components/helm/helmreleases.md)
for more details.

## Receive notifications

The default toolkit installation configures the helm-controller to
broadcast events to the [notification-controller](../components/notification/controller.md).

To receive the events as notifications, a `Provider` needs to be setup
first as described in the [notifications guide](notifications.md#define-a-provider).
Once you have set up the `Provider`, create a new `Alert` resource in
the `gitops-system` to start receiving notifications about the Helm
release:

```yaml
apiVersion: notification.fluxcd.io/v1alpha1
kind: Alert
metadata:
generation: 2
name: helm-podinfo
namespace: gitops-system
spec:
providerRef:
name: slack
eventSeverity: info
eventSources:
- kind: HelmRepository
name: podinfo
- kind: HelmChart
name: default-podinfo
- kind: HelmRelease
name: podinfo
namespace: default
```

![helm-controller alerts](../diagrams/helm-controller-alerts.png)
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ nav:
- Introduction: index.md
- Get Started: get-started/index.md
- Guides:
- Managing Helm releases: guides/helmreleases.md
- Manage Helm releases: guides/helmreleases.md
- Setup Notifications: guides/notifications.md
- Setup Webhook Receivers: guides/webhook-receivers.md
- Toolkit Components:
Expand Down

0 comments on commit 116d53a

Please sign in to comment.