From 6abb29fe81646aa0301e08dc6c6093429dfd5c99 Mon Sep 17 00:00:00 2001 From: alliasgher Date: Sun, 26 Apr 2026 18:54:57 +0500 Subject: [PATCH] docs: add debugging tips to DEVELOPMENT.md Adds a 'Debugging the controller locally' section covering knobs that are not already in 'How to run the controller locally': - RUNTIME_NAMESPACE to scope the watch - --concurrent=1 to serialize reconciles for a clean trace - flux suspend for unrelated objects sharing the cluster Assisted-by: Claude/claude-opus-4-7 Signed-off-by: alliasgher --- DEVELOPMENT.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 0530065c..a44e97e3 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -104,3 +104,42 @@ Create a `.vscode/launch.json` file: Start debugging by either clicking `Run` > `Start Debugging` or using the relevant shortcut. + + +## Operational debugging tips + +When reproducing an issue or stepping through reconciliation logic, the +following knobs make local runs cheaper and the resulting logs easier to +read. + +### Limit the watched namespace + +The controller watches every namespace by default. To narrow it to a single +namespace, set the `RUNTIME_NAMESPACE` environment variable before invoking +`make run`: + +```sh +RUNTIME_NAMESPACE=flux-system make run +``` + +### Reduce reconcile concurrency + +Each `ImageUpdateAutomation` reconcile is processed concurrently (default +`--concurrent=4`). When debugging it is almost always easier to follow a +serial trace; pass `--concurrent=1` so reconciles run one at a time: + +```sh +go run ./main.go --concurrent=1 +``` + +### Suspend unrelated objects + +If the controller is sharing a cluster with other Flux objects, suspend +anything not relevant to the test you're running so their reconciles don't +interleave with yours: + +```sh +flux suspend image update +``` + +Resume with `flux resume image update ` when you're done.