Skip to content

docs: add debugging tips to DEVELOPMENT.md#2034

Open
alliasgher wants to merge 1 commit intofluxcd:mainfrom
alliasgher:docs/666-debugging-tips
Open

docs: add debugging tips to DEVELOPMENT.md#2034
alliasgher wants to merge 1 commit intofluxcd:mainfrom
alliasgher:docs/666-debugging-tips

Conversation

@alliasgher
Copy link
Copy Markdown

What this PR does

Expands DEVELOPMENT.md with 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 tracing
  • HOSTNAME — set controller identity for local leader election
  • Suspending irrelevant objects — patch spec.suspend: true on unrelated resources
  • Scaling down the in-cluster controller — avoid competing reconciliations

Fixes #666.

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>
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