[docs] Add external Helm charts documentation (AddHelmChart)#905
Conversation
f254d35 to
d758445
Compare
d758445 to
37fcec5
Compare
37fcec5 to
a6b72fd
Compare
|
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. |
|
|
|
👋 This PR's CI has been failing consistently across multiple runs (4 attempts since May 11). The 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. |
|
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>
a6b72fd to
bb171c1
Compare
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Documents changes from microsoft/aspire#16589
Authored by
@mitchdenny.Targeting
mainbecauserelease/13.4does not yet exist onmicrosoft/aspire.dev(the milestone13.4resolved torelease/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 environmentsWithHelmValue(key, value)for--setargumentsWithNamespaceandWithReleaseNamefor overriding defaultsWithDestroy()opt-in uninstall onaspire destroy.tgz,repo/chart)Updated pages
src/frontend/src/content/docs/deployment/kubernetes/kubernetes.mdx— Added "Install external Helm charts" section with cross-referencesrc/frontend/src/content/docs/deployment/kubernetes/aks.mdx— Added "Install external Helm charts" section with cross-referencesrc/frontend/src/content/docs/deployment/kubernetes/index.mdx— Added LinkCard for new pagesrc/frontend/config/sidebar/deployment.topics.ts— Added "External Helm charts" sidebar entry under Kubernetes