Skip to content

[docs] Add external Helm charts documentation (AddHelmChart)#905

Open
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.4from
docs/helm-chart-16589-cf387ae4fa3f2474
Open

[docs] Add external Helm charts documentation (AddHelmChart)#905
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.4from
docs/helm-chart-16589-cf387ae4fa3f2474

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16589

Authored by @mitchdenny.

Targeting main because release/13.4 does not yet exist on microsoft/aspire.dev (the milestone 13.4 resolved to release/13.4, but that branch was not found in this repo).

Why this PR is needed

PR #16589 adds a significant new user-facing API — AddHelmChart — that lets AppHost authors install external Helm charts (cert-manager, NGINX ingress, monitoring tools, etc.) as post-deploy pipeline steps alongside the application's own generated Helm chart. This capability has no prior documentation on aspire.dev.

What was changed

New page

  • src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx — Full guide covering:
    • AddHelmChart(name, chartReference, chartVersion) for Kubernetes and AKS environments
    • WithHelmValue(key, value) for --set arguments
    • WithNamespace and WithReleaseName for overriding defaults
    • WithDestroy() opt-in uninstall on aspire destroy
    • Supported chart reference formats (OCI, HTTP, local path, .tgz, repo/chart)
    • Complete example and see-also links

Updated pages

  • src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx — Added "Install external Helm charts" section with cross-reference
  • src/frontend/src/content/docs/deployment/kubernetes/aks.mdx — Added "Install external Helm charts" section with cross-reference
  • src/frontend/src/content/docs/deployment/kubernetes/index.mdx — Added LinkCard for new page
  • src/frontend/config/sidebar/deployment.topics.ts — Added "External Helm charts" sidebar entry under Kubernetes

Generated by PR Documentation Check for issue #16589 · ● 19.1M ·

@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label May 11, 2026
@aspire-repo-bot aspire-repo-bot Bot requested a review from JamesNK May 11, 2026 03:46
@IEvangelist IEvangelist force-pushed the docs/helm-chart-16589-cf387ae4fa3f2474 branch from f254d35 to d758445 Compare May 11, 2026 12:24
@IEvangelist IEvangelist requested review from mitchdenny and removed request for JamesNK May 11, 2026 12:24
@IEvangelist IEvangelist changed the base branch from main to release/13.4 May 11, 2026 12:24
@IEvangelist IEvangelist marked this pull request as ready for review May 11, 2026 12:25
@IEvangelist IEvangelist force-pushed the docs/helm-chart-16589-cf387ae4fa3f2474 branch from d758445 to 37fcec5 Compare May 11, 2026 16:40
Comment on lines +19 to +20
1. Aspire generates and deploys your application's own Helm chart (`helm-deploy-{environment}`).
2. Each external chart registered with `AddHelmChart` is installed via `helm upgrade --install` (`helm-install-{name}`).
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Wrap in Steps componenet.

.WithHelmValue("config.enableGatewayAPI", "true");
```
</TabItem>
</Tabs>
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We're missing the TS apphost.ts here, even if we don't have code for it - we should at least have something in a corresponding message that calls out missing support in TS.

Documents the new AddHelmChart API introduced in microsoft/aspire#16589.

- New page: deployment/kubernetes/helm-charts.mdx
- AddHelmChart, WithHelmValue, WithNamespace, WithReleaseName, WithDestroy
- Both Kubernetes and AKS environments covered
- Sidebar entry and cross-references added

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist force-pushed the docs/helm-chart-16589-cf387ae4fa3f2474 branch from 37fcec5 to a6b72fd Compare May 12, 2026 01:13
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