Skip to content

[docs] Require Helm v4.2.0+ for Kubernetes deployment#1097

Open
aspire-repo-bot[bot] wants to merge 2 commits into
release/13.4from
docs/helm-version-requirement-13-4-b5cfb88397687e34
Open

[docs] Require Helm v4.2.0+ for Kubernetes deployment#1097
aspire-repo-bot[bot] wants to merge 2 commits into
release/13.4from
docs/helm-version-requirement-13-4-b5cfb88397687e34

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#17542 (@aspire-repo-bot / original author: @mitchdenny).

Targeting release/13.4 based on the source PR milestone 13.4.

Why this PR is needed

Aspire's Kubernetes deployment pipeline shells out to helm upgrade --install and now validates the Helm CLI version upfront before deploying. The minimum required version is Helm 4.2.0. Helm 3.x and older 4.x builds produce cryptic failures such as unknown flag: --force-conflicts or Flag --force has been deprecated; the new validation turns these into a single clear, actionable error that includes the detected version, the required version, and a link to the Helm install docs.

This was documented in both the Aspire.Hosting.Kubernetes and Aspire.Hosting.Azure.Kubernetes READMEs in the source PR — the docs site prerequisites sections need to match.

Changes

Updated the Prerequisites section in both Kubernetes deployment pages to specify Helm v4.2.0 or later:

  • src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx — Helm prerequisite updated
  • src/frontend/src/content/docs/deployment/kubernetes/aks.mdx — Helm prerequisite updated

Generated by PR Documentation Check for issue #17542 · ● 10.3M ·

Aspire now validates the Helm CLI version (>= 4.2.0) upfront before
deploying to Kubernetes. Missing or older Helm versions produce a clear
actionable error instead of cryptic flag failures like 'unknown flag:
--force-conflicts'. Update Prerequisites in both Kubernetes and AKS
deployment docs to reflect this minimum version requirement.

Documents changes from microsoft/aspire#17542.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label May 27, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from davidfowl May 27, 2026 16:34
@IEvangelist IEvangelist marked this pull request as ready for review May 27, 2026 16:43
@IEvangelist IEvangelist self-requested a review as a code owner May 27, 2026 16:43
Copilot AI review requested due to automatic review settings May 27, 2026 16:43
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates Aspire’s Kubernetes deployment documentation to reflect the new minimum Helm CLI requirement introduced by the Kubernetes deployment pipeline validation.

Changes:

  • Update Kubernetes deployment prerequisites to require Helm v4.2.0 or later
  • Update AKS deployment prerequisites to require Helm v4.2.0 or later

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx Updates the Helm prerequisite to v4.2.0+ for Kubernetes deployments.
src/frontend/src/content/docs/deployment/kubernetes/aks.mdx Updates the Helm prerequisite to v4.2.0+ for AKS deployments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx
@IEvangelist IEvangelist requested a review from mitchdenny May 28, 2026 15:33
@joperezr joperezr added this to the 13.4 milestone May 28, 2026
Copy link
Copy Markdown
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

Docs accuracy review

Source of truth: microsoft/aspire@cc4b7eaf (release/13.4, fetched 2026-05-29)
PR head: 5dffc557cb4bc3c08e4b22898e66c67d8b027111

Verdict Count
verified 1
verified-with-nuance 0
unverifiable 0
contradicted 0

Verdict: APPROVE. The added v4.2.0 or later constraint matches MinimumHelmVersion at release/13.4.

Doc-tester (UX) notes

Both prerequisite lists now match the version the runtime actually enforces; a user installing Helm from helm.sh/docs/intro/install/ will land on the right release. The phrasing is consistent across aks.mdx, kubernetes.mdx, and the version floor that HelmVersionValidator throws against.

Verified claims (with evidence)
# Claim Evidence
1 Helm "v4.2.0 or later". src/Aspire.Hosting.Kubernetes/Deployment/HelmVersionValidator.cs:28public static readonly Version MinimumHelmVersion = new(4, 2, 0);. Enforced at deploy time via HelmDeploymentEngine.cs:135-155 (check-helm-prereqs-{env} pipeline step) calling HelmVersionValidator.EnsureMinimumVersionAsync(...).

- Update shared Kubernetes prerequisites with Helm v4.2.0+ requirement (PRRT_kwDOQK_VN86FKpia)

Verified against microsoft/aspire@dfd226a on branch release/13.4.
Edited per the doc-writer skill.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs-from-code Copilot initiated issue from dotnet/aspire repo

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants