diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index a6731190..a13e970f 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -52,4 +52,44 @@ If you made any changes to CRDs API, you can update CRDs API reference doc by ```bash make api-docs -``` \ No newline at end of file +``` + +## Debugging the controller locally + +When reproducing an issue or stepping through reconciliation logic, the +following knobs make local runs cheaper and the resulting logs easier to +read. + +### Limit the watched namespace + +The controller watches every namespace by default. To narrow it to a single +namespace, set the `RUNTIME_NAMESPACE` environment variable before invoking +`make run`: + +```sh +RUNTIME_NAMESPACE=flux-system make run +``` + +### Reduce reconcile concurrency + +Each `ImageRepository` and `ImagePolicy` reconcile is processed concurrently +(default `--concurrent=4`). When debugging it is almost always easier to +follow a serial trace; pass `--concurrent=1` so reconciles run one at a +time: + +```sh +go run ./main.go --storage-path=./data --concurrent=1 +``` + +### Suspend unrelated objects + +If the controller is sharing a cluster with other Flux objects, suspend +anything not relevant to the test you're running so their reconciles don't +interleave with yours: + +```sh +flux suspend image repository +flux suspend image policy +``` + +Resume with `flux resume image repository|policy ` when you're done.