feat(core): add suspend annotation handling

[IvoGoman]

Description

all reconciliation is skipped if suspend annotation is set. This includes regular reconciliation and deletion. Deletion may be handled after the annotation is removed.

For controllers such as Catalog/Plugin the provisioned Flux resources are suspended as well. Ensuring no changes are performed in-cluster or on remote clusters.

What type of PR is this? (check all applicable)

• 🍕 Feature
• 🐛 Bug Fix
• 📝 Documentation Update
• 🎨 Style
• 🧑‍💻 Code Refactor
• 🔥 Performance Improvements
• ✅ Test
• 🤖 Build
• 🔁 CI
• 📦 Chore (Release)
• ⏩ Revert

Related Tickets & Documents

Added tests?

• 👍 yes
• 🙅 no, because they aren't needed
• 🙋 no, because I need help
• Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added to documentation?

• 📜 README.md
• 🤝 Documentation pages updated
• 🙅 no documentation needed
• (if applicable) generated OpenAPI docs for CRD changes

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• My changes generate no new warnings
• New and existing unit tests pass locally with my changes

[abhijith-darshan]

Maybe we could do this in lifecycle pkg instead? If suspend annotation exists then each greenhouse object can implement the suspend interface to set the necessary suspend field. Wdyt?

Along the same lines of skip reconcile etc…

[IvoGoman]

Maybe we could do this in lifecycle pkg instead? If suspend annotation exists then each greenhouse object can implement the suspend interface to set the necessary suspend field. Wdyt?

Along the same lines of skip reconcile etc…

The EnsureSuspended(..) is part of the reconciler interface of the lifecycle package. The Reconcile(..) ensures suspend logic of the individual controllers is called before anything else. That way the suspending can be handled in EnsureSuspended(..) and the EnsureCreated(..) ensures that reconciliation is resumed also for child resources.
By default now the Suspend Logic is "just" skipping reconciliation. But for some resources (Plugin/Catalog) it also ensures that child resources will be suspended.
Kept it as an annotation so suspending/resuming the resource would be the same interaction via kubectl. Copying this to a spec Field in the resource would also allow us to interact with the resource from UI/kubectl without a CD tool detecting a drift.

For the reconcile we could think about keeping the annotation. That way the UI could set a timestamp when a reconcile is requested for the Plugin. So that the controller does the needful. For kubectl interaction the annotation would need to be updated. Then we can in the first place ensure that this annotation will always trigger reconciliation on the resources and we can set the reconcile annotation on managed flux resources if they have changed.

[uwe-mayer]

Nice, thx for adding this!
I am sure you have thought about it: Can we have some kind of docs on how this works?

[IvoGoman]

Nice, thx for adding this! I am sure you have thought about it: Can we have some kind of docs on how this works?

Started to look into refactoring the docs as a whole. New entries are currently logged here: #1521

[abhijith-darshan]

🚀

(P.S - We need a follow-up ticket to update the E2E's for Plugin & Catalog)