Skip to content

docs: document Karpenter node scheduling for the k8s-reporter#298

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

docs: document Karpenter node scheduling for the k8s-reporter#298
AlexKantor87 merged 1 commit into
mainfrom
docs/k8s-reporter-karpenter

Conversation

@AlexKantor87

Copy link
Copy Markdown
Contributor

What

Documents the Karpenter node-scheduling controls added to the k8s-reporter chart in kosli-dev/cli#985 (chart 2.3.0), and fixes the reporting tutorial's Helm example.

Changes

  • helm/k8s_reporter.mdx — regenerated from chart 2.3.0. Adds a "Running on EKS with Karpenter (or another node autoscaler)" section and documents the new nodeSelector, tolerations, affinity and podTemplateAnnotations values; clarifies that podAnnotations is CronJob-scoped. This page is the Mintlify output of the chart's doc templates, so it was regenerated rather than hand-edited.
  • tutorials/report_k8s_envs.md — fix the Helm tab's tutorial-values.yaml, which still used the pre-v2 kosliEnvironmentName / namespaces fields (removed in chart v2.0.0), to the current reporterConfig.environments list format. Add a short Karpenter callout linking to the reference.

Why

On EKS with Karpenter the reporter CronJob can prevent node consolidation, via the consolidateAfter churn timer (kubernetes-sigs/karpenter#1921). The chart now exposes scheduling controls to avoid it; this documents them and the correct mitigations (widen the schedule, pin to a stable node group, or run out-of-cluster). It also corrects the tutorial example, which no longer works with chart v2.x.

Validation

  • mint broken-links passes for the changed pages. (It surfaces one unrelated, pre-existing broken link, /getting_started/service-accounts in working_with_controls.mdx, which this PR does not touch.)

Refs kosli-dev/cli#984, kosli-dev/cli#985

🤖 Generated with Claude Code

Regenerate the k8s-reporter chart reference from chart 2.3.0 (adds the 'Running on EKS with Karpenter' section and the nodeSelector, tolerations, affinity and podTemplateAnnotations values), and fix the reporting tutorial's Helm example to the v2 reporterConfig.environments format with a Karpenter callout.

Refs kosli-dev/cli#984

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 09:36
@claude

claude Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Claude finished @AlexKantor87's task in 2m 4s —— View job


PR Review: docs: document Karpenter node scheduling for the k8s-reporter

  • Gather context and read changed files
  • Review helm/k8s_reporter.mdx
  • Review tutorials/report_k8s_envs.md
  • Check links and conventions (CLAUDE.md compliance)
  • Post findings

Good PR — the Karpenter section is well-structured, the tutorial values fix is a needed correction, and both files follow the repo's content conventions.

helm/k8s_reporter.mdx

Improvement (inline comment posted)

  • Line 242: The nodeSelector description says "See the 'Running on EKS with Karpenter' section of the README" — "the README" is a leftover from the chart's README.md template and doesn't make sense on the docs site. Should link to the anchor on this page instead. (There's a pre-existing identical issue on the customCA description at line 346, outside this PR's scope.)

No issues found with:

  • Chart version bump (2.2.1 → 2.3.0) ✓
  • New affinity, nodeSelector, tolerations, podTemplateAnnotations param fields — alphabetically ordered, types and defaults correct ✓
  • podAnnotations description clarification (CronJob-scoped vs pod-scoped) ✓
  • Internal link /tutorials/report_k8s_envs is valid ✓
  • No relative links ✓
  • External links to karpenter.sh and the GitHub issue are well-formed ✓
  • Writing style: active voice, sentence-case headings, American spelling ✓
  • The <Warning> callout about do-not-disrupt is a nice touch — saves users from a common mis-fix

tutorials/report_k8s_envs.md

No issues found.

  • Values file correctly migrated from deprecated kosliEnvironmentName/namespaces to the v2 reporterConfig.environments list format ✓
  • Karpenter <Note> callout is concise and links to the correct anchor (/helm/k8s_reporter#running-on-eks-with-karpenter-or-another-node-autoscaler) ✓
  • No relative links ✓
  • Page already exists in config/navigation.json (no new pages added) ✓

Summary

One minor improvement suggested (inline comment on the "README" reference). Otherwise this is clean and ready.

@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, 9:37 AM

Comment thread helm/k8s_reporter.mdx
</ParamField>

<ParamField path="nodeSelector" type="object" default="{}">
Node labels for scheduling the reporter pod. On EKS with Karpenter, use this to pin the reporter to a stable managed node group (e.g. `eks.amazonaws.com/nodegroup: <name>`) so it does not interfere with node consolidation. See the "Running on EKS with Karpenter" section of the README.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improvement: "section of the README" is carried over from the chart's README.md template, but on the docs site there is no README — it's this page. Consider linking directly to the section anchor instead:

Suggested change
Node labels for scheduling the reporter pod. On EKS with Karpenter, use this to pin the reporter to a stable managed node group (e.g. `eks.amazonaws.com/nodegroup: <name>`) so it does not interfere with node consolidation. See the "Running on EKS with Karpenter" section of the README.
Node labels for scheduling the reporter pod. On EKS with Karpenter, use this to pin the reporter to a stable managed node group (e.g. `eks.amazonaws.com/nodegroup: <name>`) so it does not interfere with node consolidation. See [Running on EKS with Karpenter](#running-on-eks-with-karpenter-or-another-node-autoscaler) above.

(The pre-existing "section of the README" on the customCA description at line 346 has the same issue but is outside the scope of this PR.)

@AlexKantor87 AlexKantor87 merged commit 991bbaf into main Jul 1, 2026
6 checks passed
@AlexKantor87 AlexKantor87 deleted the docs/k8s-reporter-karpenter branch July 1, 2026 10:08
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