Skip to content

karpenter: clarify createServiceAccount semantics in docs, schema, and runtime log#8720

Open
cheeseandcereal wants to merge 1 commit intomainfrom
fix/karpenter-create-sa-docs
Open

karpenter: clarify createServiceAccount semantics in docs, schema, and runtime log#8720
cheeseandcereal wants to merge 1 commit intomainfrom
fix/karpenter-create-sa-docs

Conversation

@cheeseandcereal
Copy link
Copy Markdown
Member

Description

The karpenter.createServiceAccount flag controls which component creates the 'karpenter' service account (eksctl vs the Karpenter Helm chart), not whether a service account is created. A SA always ends up on the cluster either way. The previous docs ("create a service account or not") and silent log output for the true case made this confusing

This change:

  • Rewrites the CreateServiceAccount struct-field comment in pkg/apis/eksctl.io/v1alpha5/types.go to describe the actual behavior, and regenerates schema.json.
  • Adds a dedicated 'createServiceAccount' subsection to userdocs/src/usage/eksctl-karpenter.md explaining both modes.
  • Adds Info-level log output at runtime so eksctl reports which component will create the SA.

No behavior changes.

Checklist

  • Added tests that cover your change (if possible)
  • Added/modified documentation as required (such as the README.md, or the userdocs directory)
  • Manually tested
  • Made sure the title of the PR is a good description that can go into the release notes
  • (Core team) Added labels for change area (e.g. area/nodegroup) and kind (e.g. kind/improvement)

BONUS POINTS checklist: complete for good vibes and maybe prizes?! 🤯

  • Backfilled missing tests for code in same general area 🎉
  • Refactored something and made the world a better place 🌟

…d runtime log

The karpenter.createServiceAccount flag controls which component
creates the 'karpenter' service account (eksctl vs the Karpenter
Helm chart), not whether a service account is created. A SA always
ends up on the cluster either way. The previous docs ("create a
service account or not") and silent log output for the true case
made this confusing.

This change:
- Rewrites the CreateServiceAccount struct-field comment in
  pkg/apis/eksctl.io/v1alpha5/types.go to describe the actual
  behavior, and regenerates schema.json.
- Adds a dedicated 'createServiceAccount' subsection to
  userdocs/src/usage/eksctl-karpenter.md explaining both modes.
- Adds Info-level log output at runtime so eksctl reports which
  component will create the SA.

No behavior changes.
@cheeseandcereal cheeseandcereal added the kind/docs User documentation label Apr 28, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Hello cheeseandcereal 👋 Thank you for opening a Pull Request in eksctl project. The team will review the Pull Request and aim to respond within 1-10 business days. Meanwhile, please read about the Contribution and Code of Conduct guidelines here. You can find out more information about eksctl on our website

@cheeseandcereal cheeseandcereal enabled auto-merge (squash) April 28, 2026 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/docs User documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant