Skip to content

docs: reorder k8s-reporter Karpenter guidance to lead with pinning#299

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

docs: reorder k8s-reporter Karpenter guidance to lead with pinning#299
AlexKantor87 merged 1 commit into
mainfrom
docs/k8s-reporter-karpenter-order

Conversation

@AlexKantor87

Copy link
Copy Markdown
Contributor

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

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

Regenerate the k8s_reporter reference from chart 2.3.1: node-group pinning is now 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.

Refs kosli-dev/cli#987

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@AlexKantor87 AlexKantor87 requested a review from a team as a code owner July 1, 2026 10:25
@claude

claude Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

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


PR Review: Reorder Karpenter guidance

  • Gather context and read diff
  • Read full changed file
  • Check CLAUDE.md compliance (links, style, frontmatter)
  • Verify internal links resolve
  • Post review findings

Review findings

Scope: helm/k8s_reporter.mdx — the only file changed in this PR.

Diátaxis classification: Reference page (Helm chart). The Karpenter section is a how-to embedded in the reference, which is appropriate here since it's operationally coupled to chart values.

Critical

None.

Improvement

  1. helm/k8s_reporter.mdx:3 — frontmatter description uses "cronjob" (lowercase)
    The page body correctly capitalizes "CronJob" (line 12), but the frontmatter description still reads "A Helm chart for installing the Kosli K8S reporter as a cronjob." — this predates this PR, but since the chart version bump touched the <Info> block it would be a good moment to fix it to "CronJob" for consistency.

Suggestion

  1. helm/k8s_reporter.mdx:168 — introductory paragraph could be tighter
    The new lead-in sentence ("Frequent snapshots are what let Kosli surface drift…") is good framing, but repeats the word "Widening" immediately after using it in the next clause. Minor wording polish — e.g., "Increasing the interval trades away that detection speed…" — would read more smoothly. Very optional.

Summary

Category Count
Critical 0
Improvement 1
Suggestion 1

Overall: Clean, well-motivated reorder. The change correctly promotes the options that preserve reporting cadence (node-group pinning and out-of-cluster) above the option that sacrifices it (wider interval). All internal links resolve (/tutorials/report_k8s_envstutorials/report_k8s_envs.md), no relative links, frontmatter is present, and writing style follows CLAUDE.md conventions. The chart version bump to 2.3.1 is consistent with the source PR. Ship it.

@mintlify

mintlify Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
kosli 🟢 Ready View Preview Jul 1, 2026, 10:29 AM

@AlexKantor87 AlexKantor87 merged commit a94a0e6 into main Jul 1, 2026
6 checks passed
@AlexKantor87 AlexKantor87 deleted the docs/k8s-reporter-karpenter-order branch July 1, 2026 11:35
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.

2 participants