docs: add debugging tips to DEVELOPMENT.md - #1300
Conversation
5c40404 to
b937a0c
Compare
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 <alliasgher123@gmail.com>
b937a0c to
7d25703
Compare
|
Self-correcting this before it wastes a reviewer's time: two of the tips in this PR are wrong, and I only found out because @stefanprodan reviewed the same text on the kustomize-controller version (fluxcd/kustomize-controller#1646). The if !watchOptions.AllNamespaces {
watchNamespace = os.Getenv("RUNTIME_NAMESPACE")
}and the flag defaults to The That is most of the substance, so I do not think there is a useful PR left here. Happy to close it, or to cut it down to just the accurate remainder if a maintainer thinks that is worth keeping. Sorry for the noise, and for sending the same wrong text to several repos at once. |
|
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. |
Summary
Adds a 'Debugging the controller locally' section to
DEVELOPMENT.mdcovering knobs not already in 'How to run the controller locally':RUNTIME_NAMESPACEto scope the watch--concurrent=1to serialize reconciles for a clean traceflux suspendfor unrelated objects sharing the clusterCross-controller setup is already documented (or n/a for this controller) and is not duplicated here.
Assisted-by: Claude/claude-opus-4-7