Skip to content

Commit 6eb4f03

Browse files
authored
Add events/notification docs in README docs (#63)
* Add events/notification docs in README docs * Apply review comments
1 parent 7c679cd commit 6eb4f03

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -813,3 +813,11 @@ When a GitOpsSet that uses disabled generators is created, the disabled generato
813813

814814
[^yaml]: These are written as YAML mappings
815815
[^sprig]: The following functions are removed "env", "expandenv", "getHostByName", "genPrivateKey", "derivePassword", "sha256sum", "base", "dir", "ext", "clean", "isAbs", "osBase", "osDir", "osExt", "osClean", "osIsAbs"
816+
817+
## Notifications
818+
819+
Events are enabled which will trigger Kubernetes events when successful reconciliation occurs with a `Normal` event or when reconciliation fails with an `Error` event. Fluxcd's [Events](https://pkg.go.dev/github.com/fluxcd/pkg/runtime/events) package is used including the `EventRecorder` to record these events.
820+
821+
To configure receiving the recorded events on a specific host, this can be provided via the `--events-addr` flag in `RUN_ARGS` when starting the controller. This can be any HTTP endpoint.
822+
823+
See [fluxcd event](https://github.com/fluxcd/pkg/blob/main/apis/event/v1beta1/event.go) for the struct of the event created.

0 commit comments

Comments
 (0)