docs: document Karpenter node scheduling for the k8s-reporter#298
Conversation
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>
|
Claude finished @AlexKantor87's task in 2m 4s —— View job PR Review: docs: document Karpenter node scheduling for the k8s-reporter
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.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| </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. |
There was a problem hiding this comment.
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:
| 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.)
What
Documents the Karpenter node-scheduling controls added to the
k8s-reporterchart 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 newnodeSelector,tolerations,affinityandpodTemplateAnnotationsvalues; clarifies thatpodAnnotationsis 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'stutorial-values.yaml, which still used the pre-v2kosliEnvironmentName/namespacesfields (removed in chart v2.0.0), to the currentreporterConfig.environmentslist format. Add a short Karpenter callout linking to the reference.Why
On EKS with Karpenter the reporter CronJob can prevent node consolidation, via the
consolidateAfterchurn 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-linkspasses for the changed pages. (It surfaces one unrelated, pre-existing broken link,/getting_started/service-accountsinworking_with_controls.mdx, which this PR does not touch.)Refs kosli-dev/cli#984, kosli-dev/cli#985
🤖 Generated with Claude Code