Skip to content

docs: expand local debugging guidance in DEVELOPMENT.md - #1367

Open
amarkdotdev wants to merge 1 commit into
fluxcd:mainfrom
amarkdotdev:docs/362-local-debugging
Open

docs: expand local debugging guidance in DEVELOPMENT.md#1367
amarkdotdev wants to merge 1 commit into
fluxcd:mainfrom
amarkdotdev:docs/362-local-debugging

Conversation

@amarkdotdev

Copy link
Copy Markdown
Contributor

Summary

  • Expand DEVELOPMENT.md with a practical local-debugging guide: scale down the in-cluster Deployment, suspend unrelated Alert/Provider/Receiver objects, raise log verbosity, POST synthetic events, exercise Receiver webhooks, and attach VS Code.
  • Document the local listen addresses used by make run (events, receiver, metrics, health).
  • Explicitly avoid the incorrect RUNTIME_NAMESPACE / --concurrent=1 advice from closed docs: add debugging tips to DEVELOPMENT.md #1300; explain why keeping --watch-all-namespaces (default) is preferred when reproducing cross-namespace behaviour.

Fixes #362

Test plan

  • Read the new section for accuracy against main.go flags and make run
  • Confirm flux suspend alert|alert-provider|receiver --all command names
  • Spot-check the sample event JSON against event.toolkit.fluxcd.io/v1beta1.Event
  • DCO Signed-off-by present on the commit

Document how to run the controller alone against a shared cluster,
suspend unrelated objects, raise log verbosity, exercise the events
API and Receiver webhooks, and attach a debugger — without the
incorrect RUNTIME_NAMESPACE / --concurrent tips from earlier attempts.

Fixes fluxcd#362

Signed-off-by: amarkdotdev <amarkdotdev@users.noreply.github.com>
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.

Improve documentation on debugging the controller locally

1 participant