stacklok / toolhive / 28101234055

Build # 28101234055

Build Type

push

github

Committed by web-flow

Commit Message

Document level-triggered operator reconciliation rules (#5609)

* Document level-triggered operator reconcile rules

The operator rules file covered CRD conventions and status/spec patching
mechanics but said nothing about the reconciliation principles those
mechanics serve. Add the governing rule — a reconciler is an idempotent,
level-triggered function from observed state to desired state — plus
supporting rules for errors/requeue, status and conditions, ownership
and finalizers, API hygiene and concurrency, scale and event plumbing,
validation, and manager bootstrap.

Each rule was verified against the actual cmd/thv-operator code, cites a
real exemplar, and notes the codebase's tolerated exceptions so the
rules apply without over-flagging conformant patterns.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Correct operator-rule inaccuracies from review

Address review findings against the actual cmd/thv-operator code:

- conditions.go holds only the shared Valid/DeletionBlocked types;
  per-CRD condition types live in their *_types.go files. Reword so the
  rule doesn't push CRD-specific types into the shared file.
- The Helm chart passes --leader-elect unconditionally, not gated on
  replicaCount; describe actual behaviour and warn against "fixing" it
  into a default-off conditional.
- The only leader-only runnable is a usage/update-check worker
  (pkg/operator/telemetry), not an OTEL metrics emitter; state the
  operator exposes no custom domain metrics today.
- Prefix the GC helper packages with cmd/thv-operator/.
- Replace the non-actionable "belt-and-suspenders, not mandatory"
  predicate note with a default-plus-reason (do not add it).
- Add a note that file pointers are illustrations accurate as of the
  last edit and the structural pattern is authoritative, so "do not
  copy"/"being migrated" markers don't rot into false claims.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

* Fix codespell... (continued)

Coverage Stats

69668 of 103719 relevant lines covered (67.17%)

65.74 hits per line

Source File

Press 'n' to go to next uncovered line, 'b' for previous

Source Not Available