Improve documentation on debugging the controller locally
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 82/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- go, kubernetes
- Domain
- devops, documentation
Research direction
Start with DEVELOPMENT.md and follow its existing local debugging guidance for the source-controller. Expand the documentation to cover suspending irrelevant objects, HOSTNAME and RUNTIME_NAMESPACE, reducing --concurrent to 1, and configuring cross-controller interactions; done means users can use these instructions to debug or reproduce issues locally.
Written by the indexing model from the issue text.
Description
The DEVELOPMENT.md could be improved to help users trying to debug problems or reproduce reported issues.
Things we could expand on:
- Suspend objects that are irrelevant to the test at hand.
- Environment variables
HOSTNAME: set tosource-controller.RUNTIME_NAMESPACE: limit the namespaces being watched.
- Arguments
--concurrent: decreasing concurrency to 1.
- Configuring cross-controller interactions.
- Dominant language
- Go
- Stars
- 283
- Forks
- 252
- Avg merge
- 1h 6m
- Merged PRs (30d)
- 12
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from fluxcd/source-controller
-
area/git bug
Difficulty 4/5 3-5 days Newbie friendliness 55/100
fluxcd/source-controller#2165 · 3 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
fluxcd/source-controller#2150 ·
-
GitRepository `.spec.ref.commit` + `.spec.ref.branch` does not shallow clone, contrary to the docs Open
Difficulty 5/5 Over a week Newbie friendliness 42/100
fluxcd/source-controller#2146 · 2 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 55/100
fluxcd/source-controller#2136 · 1 comment ·
-
HelmRepository: use conditional HTTP requests (ETag / If-Modified-Since) when fetching index.yaml Open
Difficulty 4/5 3-5 days Newbie friendliness 48/100
fluxcd/source-controller#2113 · 1 comment ·
All issues in fluxcd/source-controller
Similar issues
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
kind/bug status/0-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
🤔 refinement needed
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
equinor/radix-operator#1979 ·