Skip to content

Commit

Permalink
Merge pull request #140 from controlplaneio-fluxcd/docs-flux-operator…
Browse files Browse the repository at this point in the history
…-v0.13

Update the Flux Operator docs for v0.13.0
  • Loading branch information
stefanprodan authored Jan 10, 2025
2 parents 77a5705 + 773c7a4 commit 5c11345
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/operator/fluxinstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,7 @@ The reconciliation behaviour can be configured using the following annotations:

- `fluxcd.controlplane.io/reconcile`: Enable or disable the reconciliation loop. Default is `enabled`, set to `disabled` to pause the reconciliation.
- `fluxcd.controlplane.io/reconcileEvery`: Set the reconciliation interval. Default is `1h`.
- `fluxcd.controlplane.io/reconcileArtifactEvery`: Set the artifact reconciliation interval. Default is `10m`.
- `fluxcd.controlplane.io/reconcileTimeout`: Set the reconciliation timeout. Default is `5m`.

### Sync configuration
Expand Down
33 changes: 33 additions & 0 deletions docs/operator/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,39 @@ To list the events related to the Flux instance, run:
kubectl -n flux-system events --for fluxinstance/flux
```

The Flux Operator integrates with notification-controller. To receive notifications with the
events issued by the operator, you can configure alerting as follows:

```yaml
apiVersion: notification.toolkit.fluxcd.io/v1beta3
kind: Provider
metadata:
name: slack-bot
namespace: flux-system
spec:
type: slack
channel: general
address: https://slack.com/api/chat.postMessage
secretRef:
name: slack-bot-token
---
apiVersion: notification.toolkit.fluxcd.io/v1beta3
kind: Alert
metadata:
name: flux-operator
namespace: flux-system
spec:
providerRef:
name: slack-bot
eventSeverity: info
eventSources:
- kind: FluxInstance
name: flux
```
Besides Slack, the notification-controller supports other providers like Microsoft Teams, Datadog, Grafana, etc.,
for more information see the [alert provider documentation](https://fluxcd.io/flux/components/notification/providers/).
## Prometheus Metrics
The Flux Operator exports metrics in the Prometheus format for monitoring
Expand Down

0 comments on commit 5c11345

Please sign in to comment.