Skip to content

[docs] Update Kubernetes deployment docs to document aspire deploy with Helm engine#766

Draft
aspire-repo-bot[bot] wants to merge 1 commit intorelease/13.3from
docs/kubernetes-deploy-helm-13.3-b31379655a6ca4d6
Draft

[docs] Update Kubernetes deployment docs to document aspire deploy with Helm engine#766
aspire-repo-bot[bot] wants to merge 1 commit intorelease/13.3from
docs/kubernetes-deploy-helm-13.3-b31379655a6ca4d6

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#15723

@mitchdenny

Target branch

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

Why this PR is needed

PR microsoft/aspire#15723 ("Add Kubernetes deploy pipeline with Helm engine") added full aspire deploy support for Kubernetes environments. The existing deployment/kubernetes.mdx page explicitly stated that aspire deploy was not supported — this is now incorrect and needed to be updated.

What was changed

Updated src/frontend/src/content/docs/deployment/kubernetes.mdx:

  • Removed the <Aside> note claiming aspire deploy is unsupported for Kubernetes
  • Updated the page description frontmatter to mention both aspire publish and aspire deploy
  • Updated the introductory paragraph to list both capabilities
  • Added a new "Deploy with aspire deploy" section covering:
    • The end-to-end pipeline: Build → Push → Prepare → Helm Deploy → Print Summary
    • The WithHelm() builder API for configuring namespace, release name, and chart version
    • A note about prerequisites (helm and kubectl must be installed and configured)
  • Renamed the existing Helm section to "Deploy with Helm manually" to distinguish it from automated aspire deploy
  • Added a link to External parameters in the See also section

Files modified

  • src/frontend/src/content/docs/deployment/kubernetes.mdx (updated)

This draft PR needs human review before merging to ensure technical accuracy and completeness.

Generated by PR Documentation Check · ● 725.5K ·

…h Helm engine

- Remove incorrect note stating aspire deploy is unsupported for Kubernetes
- Update page description to reflect both aspire publish and aspire deploy
- Add new 'Deploy with aspire deploy' section documenting the Helm pipeline:
  - Build → Push → Prepare → Helm Deploy → Print Summary pipeline
  - WithHelm() builder API for namespace, release name, and chart version
  - Prerequisites note for helm and kubectl
- Rename manual Helm section to 'Deploy with Helm manually' for clarity
- Add External parameters link to See also

Documents changes from microsoft/aspire#15723

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 Apr 28, 2026
@joperezr
Copy link
Copy Markdown
Member

@mitchdenny, can you take a look at this one please?

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.

1 participant