Add Kubernetes persistent volume documentation#1328
Merged
Conversation
Document the first-class KubernetesPersistentVolumeResource feature (microsoft/aspire PR #16929): a dedicated Persistent volumes on Kubernetes page under deployment/kubernetes, a concise pointer in the Kubernetes integration reference, sidebar wiring, and cross-links from related Kubernetes and data-persistence pages. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds end-to-end documentation for modeling and binding Kubernetes persistent volumes in Aspire, and integrates the new page into the Kubernetes deployment doc set (sidebar + cross-links).
Changes:
- Adds a new reference page for Kubernetes persistent volumes, including configuration, binding patterns, and sample generated output.
- Updates the Kubernetes integration doc with a new “Persistent volumes” section and a link to the dedicated page.
- Adds cross-links from related fundamentals/deployment pages and registers the new page in the Deployment › Kubernetes sidebar.
Show a summary per file
| File | Description |
|---|---|
| src/frontend/src/content/docs/integrations/compute/kubernetes.mdx | Adds a persistent volumes section with C#/TS examples and a LearnMore link; adds “See also” entry. |
| src/frontend/src/content/docs/fundamentals/persist-data-volumes.mdx | Adds cross-link to the new Kubernetes persistent volumes page. |
| src/frontend/src/content/docs/deployment/kubernetes/persistent-volumes.mdx | New dedicated persistent volumes reference page (configuration surface, binding overloads, YAML excerpts). |
| src/frontend/src/content/docs/deployment/kubernetes/clusters.mdx | Adds “See also” cross-link to persistent volumes page. |
| src/frontend/src/content/docs/deployment/kubernetes.mdx | Adds overview-level pointer and a new LinkCard for persistent volumes. |
| src/frontend/config/sidebar/deployment.topics.ts | Registers the new page under Deployment › Kubernetes in the sidebar. |
Review details
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 6/6 changed files
- Comments generated: 3
- Review effort level: Low
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Refocus the opening on the AddPersistentVolume fluent API with a minimal example up front, rather than the KubernetesPersistentVolumeResource class name, matching how developers think in terms of AppHost APIs. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
- Correct withDataVolume TS calls to pass an options object
(withDataVolume({ name: 'pg-data' })) instead of a name string; the
TypeScript binding takes WithDataVolumeOptions, not a string.
- Clarify the config-method table: in TypeScript the parameter-accepting
variants are separate methods (withPvStorageClassParam,
withPvCapacityParam, withVolumeAnnotationParam), not overloads of the
string methods.
Verified against the shipped Aspire 13.5.0-preview.1 package by compiling
and publishing both examples with the dev CLI.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the first-class
KubernetesPersistentVolumeResourcefeature merged in microsoft/aspire #16929, targeting the release/13.5 branch.Changes
deployment/kubernetes/persistent-volumes.mdx: full reference coveringAddPersistentVolume, the fluent configuration surface (WithStorageClass,WithCapacity,WithAccessMode,WithVolumeAnnotation), thePersistentVolumeAccessModevalues, both binding overloads (name-match and mount-path), the automaticStatefulSetpromotion, unbound-volume fallthrough, and generated YAML. C#/TypeScript parity throughout.integrations/compute/kubernetes.mdx: concise summary and example with aLearnMorepointer to the dedicated page; added to See also.Validation
pnpm --dir ./src/frontend run lintpassestest:unit:docspassesseo-lengthsguard passes