fluxcd / flux2

Open and extensible continuous delivery solution for Kubernetes. Powered by GitOps Toolkit.
https://fluxcd.io
Apache License 2.0
6.58k stars 608 forks source link

Update Example controller to new unified standards #1625

Open scottrigby opened 3 years ago

scottrigby commented 3 years ago

We already have an example controller that consumes the GitOps Toolkit Source APIs fluxcd/source-watcher. This accompanies the Watching for source changes Flux guide.

The example is however out of date with the new Flux controller standards that are currently in the process of being rolled out (https://github.com/fluxcd/flux2/issues/1601).

We need to make the example controller more complex, to help people understand how to use pkg/runtime. Must contain in-code documentation. This is a pre-step for updating the guide.

scottrigby commented 3 years ago

@stefanprodan suggests that we keep source-watcher as-is, because there is value in this as an example for IoT.

Thoughts on the new example: