docs: Revise guidance for enabling Azure/AKS features in Karpenter - #1876
Open
Wilson (wdarko1) wants to merge 3 commits into
Open
docs: Revise guidance for enabling Azure/AKS features in Karpenter#1876Wilson (wdarko1) wants to merge 3 commits into
Wilson (wdarko1) wants to merge 3 commits into
Conversation
Updated the guidance document for enabling Azure/AKS features in Karpenter by refining language and clarifying points. Adjusted checklist items for better readability and understanding.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new design-guidance document intended to help contributors consistently expose new Azure/AKS features in the Karpenter Azure provider (covering API surfacing decisions, defaulting, hashing/drift, validation, filtering, provisioning paths, and testing expectations).
Changes:
- Introduces a comprehensive “feature enablement” checklist and decision framework derived from past feature landings.
- Documents common failure modes (defaults, hash bumps, CEL rules, cache keys, VM vs AKS Machine API parity, bootstrapping drift) and where to implement changes.
- Provides a testing/production-readiness rubric to align contributor PRs with reviewer expectations.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
Suppressed comments (1)
Previously missed (1) — in code that hasn't changed since the last review.
designs/0000-feature-enablement-guide.md:309
- Severity: Low; Category: Correctness — This guidance points contributors to
inplaceupdate/utils.go, but that path doesn’t exist in the repo. The in-place update field structs live underpkg/controllers/nodeclaim/inplaceupdate/utils.go, so following this as written will send people to the wrong location (or make them think the code is missing).
* Add it to `vmInPlaceUpdateFields` and/or `aksMachineInPlaceUpdateFields`
(`inplaceupdate/utils.go`). They are **not symmetric** — VM identities are handled
server-side for AKS machines and are deliberately absent from the machine struct.
Clarified default behavior for Karpenter features to align with AKS AgentPool API.
Comment on lines
+121
to
+122
| The default behavior for any added feature in Karpenter should, where possible, match the defaults in the AKS Agentpool API. | ||
| Also for Azure features, the Karpenter path should expose similar control to the AKS Agentpool API. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Created guidance document for enabling Azure/AKS features in Karpenter by refining language and clarifying points. Adjusted checklist items for better readability and understanding.
Description
A feature enabled guide for contributors. This includes gotchas and builds on previous maintainer/reviewer comments to improve contribution quality.