Skip to content

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

Merged
IEvangelist merged 2 commits into
release/13.4from
docs/helm-chart-16589-cf387ae4fa3f2474
Jun 1, 2026
Merged

[docs] Add external Helm charts documentation (AddHelmChart)#905
IEvangelist merged 2 commits 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 thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
@IEvangelist IEvangelist force-pushed the docs/helm-chart-16589-cf387ae4fa3f2474 branch from 37fcec5 to a6b72fd Compare May 12, 2026 01:13
@joperezr joperezr added this to the 13.4 milestone May 28, 2026
@IEvangelist

Copy link
Copy Markdown
Member

CI has been rerun multiple times for this PR and continues to fail (ci-gate). This looks more like a PR-specific issue than a flaky run, so the changes likely need to be updated before CI will pass consistently.

@IEvangelist

Copy link
Copy Markdown
Member

⚠️ CI has failed multiple times on this PR. The failures appear to be related to content changes in this PR rather than transient infrastructure issues. Please review the CI logs and fix the underlying issue before this can be merged.

@IEvangelist

Copy link
Copy Markdown
Member

👋 This PR's CI has been failing consistently across multiple runs (4 attempts since May 11). The frontend-build job keeps failing/being cancelled, which causes the ci-gate check to fail.

The failure pattern suggests the issue may be related to changes in this PR itself (specifically frontend/docs changes that cause the build to fail). Could someone please investigate and fix the underlying issue?

Runs:

I've retriggered the last run — if it fails again, the PR content likely needs to be updated.

@IEvangelist

Copy link
Copy Markdown
Member

Some CI checks have been retriggered multiple times and are still failing. This may be due to changes in this PR and may need to be fixed manually.

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 a6b72fd to bb171c1 Compare June 1, 2026 14:11
Copilot AI review requested due to automatic review settings June 1, 2026 14:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds end-user documentation for the new AddHelmChart API so Aspire AppHost authors can install external Helm charts (e.g., cert-manager) as post-deploy steps alongside the app’s generated Helm chart.

Changes:

  • Adds a new “Install external Helm charts” guide under Kubernetes deployment docs.
  • Cross-links the new guide from the Kubernetes and AKS deployment pages and the Kubernetes landing page.
  • Adds a Kubernetes sidebar entry for the new page.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx New end-to-end guide for installing/configuring external Helm charts with Aspire Kubernetes/AKS environments.
src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx Adds a section linking to the new external Helm charts guide.
src/frontend/src/content/docs/deployment/kubernetes/aks.mdx Adds a section linking to the new external Helm charts guide.
src/frontend/src/content/docs/deployment/kubernetes/index.mdx Adds a LinkCard entry to surface the new guide on the Kubernetes landing page.
src/frontend/config/sidebar/deployment.topics.ts Adds a sidebar entry for the new guide under Kubernetes.

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

Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx Outdated
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx Outdated
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx Outdated
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/helm-charts.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx
Comment thread src/frontend/src/content/docs/deployment/kubernetes/aks.mdx
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist IEvangelist enabled auto-merge (squash) June 1, 2026 15:20
@IEvangelist IEvangelist merged commit 8ba9f76 into release/13.4 Jun 1, 2026
9 checks passed
@IEvangelist IEvangelist deleted the docs/helm-chart-16589-cf387ae4fa3f2474 branch June 1, 2026 15:32
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