docs: add debugging tips to DEVELOPMENT.md - #2034
Conversation
Expand the local development guide with concrete tips for debugging controller issues, as requested in fluxcd#666: - RUNTIME_NAMESPACE env var to limit watched namespaces - --concurrent=1 flag to serialise reconcile loops - HOSTNAME env var for leader election identity - How to suspend irrelevant Flux objects to reduce log noise - How to scale down the in-cluster deployment to avoid conflicts Signed-off-by: Ali <alliasgher123@gmail.com> Assisted-by: Claude/claude-opus-4-7
b7ec8f4 to
17f7fc6
Compare
|
Small issue with the Could this either use a direct |
The Makefile run target does not pass ARGS through to go run, so the make run ARGS=... example silently dropped the flag. Use go run directly with the same storage flags the run target sets. Signed-off-by: Ali <alliasgher123@gmail.com>
|
Good catch, fixed in a1ba6ca using a direct go run invocation with the run target's storage flags. |
|
Closing this. Two of the three tips were wrong rather than merely imprecise, and once they are removed there is not enough left to justify a review cycle. For the record, so this is searchable if anyone tries the same thing later:
Thanks @stefanprodan for the review that caught this, and apologies to the other repos for receiving the same wrong text. If a maintainer does want a debugging section in DEVELOPMENT.md, I am happy to write one from scratch against what the flags actually do. |
What this PR does
Expands
DEVELOPMENT.mdwith a Debugging tips section under "How to run the controller locally", covering the items listed in #666:RUNTIME_NAMESPACE— restrict watched namespaces to reduce noise--concurrent=1— serialise reconcile loops for easier tracingHOSTNAME— set controller identity for local leader electionspec.suspend: trueon unrelated resourcesFixes #666.
Assisted-by: Claude/claude-opus-4-7