Skip to content

docs: add debugging tips to DEVELOPMENT.md#881

Open
alliasgher wants to merge 2 commits into
fluxcd:mainfrom
alliasgher:docs-debugging-tips
Open

docs: add debugging tips to DEVELOPMENT.md#881
alliasgher wants to merge 2 commits into
fluxcd:mainfrom
alliasgher:docs-debugging-tips

Conversation

@alliasgher

@alliasgher alliasgher commented Apr 25, 2026

Copy link
Copy Markdown

Summary

Adds a 'Debugging the controller locally' section to DEVELOPMENT.md covering knobs 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

Cross-controller setup is already documented (or n/a for this controller) and is not duplicated here.

Assisted-by: Claude/claude-opus-4-7

@alliasgher alliasgher force-pushed the docs-debugging-tips branch from 7ebfb59 to 31cc6fb Compare April 26, 2026 13:54
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>
@alliasgher alliasgher force-pushed the docs-debugging-tips branch from 31cc6fb to ee5f201 Compare April 26, 2026 14:35
@SyedAsadRazaDevops

SyedAsadRazaDevops commented Jun 11, 2026

Copy link
Copy Markdown

Small accuracy issue in the --concurrent=1 example: this bypasses the local-run storage path used by the documented make run target. make run runs go run ./main.go --storage-path=./data, while main.go defaults --storage-path to /data.

Should this example be go run ./main.go --storage-path=./data --concurrent=1 so the debugging command uses the same local data path as the rest of this development guide?

main.go defaults --storage-path to /data, which does not exist on a dev
machine. Match the make run target's ./data path so the example works
alongside the rest of the guide.

Signed-off-by: Ali <alliasgher123@gmail.com>
@alliasgher

Copy link
Copy Markdown
Author

Good catch, fixed in 48d49d9 by adding --storage-path=./data to the example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants