Skip to content

docs(k8s-reporter): lead Karpenter guidance with pinning, widening as last resort#987

Merged
AlexKantor87 merged 1 commit into
mainfrom
chart/k8s-reporter-karpenter-docs-order
Jul 1, 2026
Merged

docs(k8s-reporter): lead Karpenter guidance with pinning, widening as last resort#987
AlexKantor87 merged 1 commit into
mainfrom
chart/k8s-reporter-karpenter-docs-order

Conversation

@AlexKantor87

Copy link
Copy Markdown
Contributor

What

Reorders the "Running on EKS with Karpenter" guidance in the k8s-reporter chart docs so pinning is the recommended fix and widening the report interval is a caveated last resort. Follow-up to #985.

Why

Frequent snapshots are how Kosli surfaces drift or an unauthorized change quickly. Widening the reporter interval to placate Karpenter trades that detection speed away, so it should not be the headline recommendation. Pinning the reporter to a stable node group (or running it out-of-cluster) solves the consolidation interference while keeping the 5-minute cadence.

Changes

  • Reorder the section in both _templates.gotmpl (chart README) and _mintlify_templates.gotmpl (docs.kosli.com source): 1) pin to a stable node group (recommended), 2) run out-of-cluster, 3) widen the interval (last resort, with the detection-speed caveat).
  • Regenerate README.md.
  • Bump chart 2.3.02.3.1 (docs only; no change to rendered manifests).

No Kubernetes manifest changes; helm lint passes.

Refs #984

🤖 Generated with Claude Code

… last resort

Reorder the 'Running on EKS with Karpenter' section in the chart README and Mintlify docs so node-group pinning is the recommended fix and widening the report interval is a caveated last resort. Frequent snapshots are how Kosli surfaces drift quickly, so slowing the reporter down trades away detection speed. Regenerate README and bump the chart to 2.3.1 (docs only, no manifest change).

Refs #984

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

claude Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @AlexKantor87's task in 40s —— View job


Review: docs(k8s-reporter) Karpenter guidance reorder

  • Read PR diff and changed files
  • Verify README is consistent with both templates
  • Check for stale cross-references / section-number links
  • Assess static-analysis relevance (Go build/vet)
  • Post review

This is a docs-only PR — no Go source, manifests, or values.yaml changed. go build/go vet/go mod tidy aren't relevant here, so I skipped Phase 1 static analysis (nothing they'd touch).

What the PR does well ✅

  • Sound rationale. Leading with pinning and demoting widening the interval to a caveated last resort is the right call — frequent snapshots are the whole point of the reporter, and the PR keeps that reasoning front-and-center in the new intro paragraph.
  • Consistency across all three sources. The reorder is applied identically to _templates.gotmpl (chart README source), _mintlify_templates.gotmpl (docs.kosli.com source), and the regenerated README.md. I grepped for the moved headings and intro line — all three files match, section numbering is 1 → 2 → 3 with no gaps, and no stale ### 1/2/3 links exist elsewhere.
  • Correct SemVer bump. 2.3.0 → 2.3.1 (PATCH) is appropriate for a docs-only change with no manifest impact, and the version badge in README.md was updated to match.
  • The do-not-disrupt warning is preserved at the end of the section, unchanged — good, since that caveat is still valid regardless of ordering.

Minor observations (non-blocking)

  1. "out of cluster" vs "out-of-cluster". In the new section-3 sentence "Only if you cannot pin the reporter or move it out of cluster:" — the adjacent heading/section uses "out of the cluster". Reads fine, just a slight phrasing inconsistency. Optional.
  2. Slightly long intro sentence. The new paragraph (Frequent snapshots are what let Kosli surface drift... should be a last resort.) packs two ideas into one sentence. Splitting into two would read a touch easier, but it's clear as-is. Optional.
  3. Regeneration provenance. The PR says README.md was regenerated. Since it's hand-verifiable here and matches _templates.gotmpl exactly, no concern — just worth confirming it came from the generator (helm-docs) rather than a manual edit, so future regenerations don't drift.

Verdict

Clean, well-reasoned documentation improvement. Content is consistent across all three sources, numbering and version bump are correct, and no broken references. Looks good to merge — the observations above are purely optional polish.
· chart/k8s-reporter-karpenter-docs-order

@AlexKantor87 AlexKantor87 merged commit 961a936 into main Jul 1, 2026
20 checks passed
@AlexKantor87 AlexKantor87 deleted the chart/k8s-reporter-karpenter-docs-order branch July 1, 2026 11:35
AlexKantor87 added a commit to kosli-dev/docs that referenced this pull request Jul 1, 2026
)

## What

Reorders the "Running on EKS with Karpenter" section on the k8s-reporter
reference so node-group pinning leads and widening the report interval
is a caveated last resort. Regenerated from k8s-reporter chart 2.3.1
([kosli-dev/cli#987](kosli-dev/cli#987)).

## Why

Widening the reporter interval to avoid Karpenter consolidation trades
away detection speed, and frequent snapshots are how Kosli surfaces
drift or an unauthorized change quickly. Pinning the reporter to a
stable node group (or running it out-of-cluster) keeps the cadence, so
those are now the headline options and widening is framed as a last
resort.

## Note

This page is generated from the chart's Mintlify template, so it was
regenerated rather than hand-edited; the source change is in
[kosli-dev/cli#987](kosli-dev/cli#987). `mint
broken-links` passes for this page (the one unrelated pre-existing
broken link, `/getting_started/service-accounts` in
`working_with_controls.mdx`, is untouched).

Refs kosli-dev/cli#987

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.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.

3 participants