[docs] Fix persistent container endpoint proxy default docs#1227
Merged
IEvangelist merged 2 commits intoJun 8, 2026
Merged
Conversation
Persistent containers use proxied endpoints by default (same as session containers), while persistent executables and projects default to proxyless endpoints. Also document that proxyless container endpoints with only a targetPort immediately allocate the targetPort as the host port. Corrects docs that previously stated all persistent resources default to proxyless endpoints. Documents changes from microsoft/aspire#17960. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
IEvangelist
added
the
docs-from-code
Contributor
There was a problem hiding this comment.
Pull request overview
Updates Aspire documentation to reflect the corrected endpoint proxy defaults for persistent containers (proxied by default) versus persistent executables/projects (proxyless by default), and documents the restored behavior for proxyless container endpoints that specify only targetPort.
Changes:
- Clarify that persistent containers default to proxied endpoints, while persistent executables/projects default to proxyless endpoints.
- Document that proxyless container endpoints with only
targetPortimmediately allocate the host port (no deferred allocation). - Scope “proxyless-by-default” statements in the Aspire 13.4 release notes to executables/projects (not containers).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/frontend/src/content/docs/app-host/resource-lifetimes.mdx | Updates persistent lifetime endpoint-default wording to distinguish containers vs executables/projects and notes immediate targetPort allocation for proxyless containers. |
| src/frontend/src/content/docs/fundamentals/networking-overview.mdx | Corrects proxyless endpoint definition and expands the proxyless endpoints section to reflect container vs executable/project defaults and immediate allocation behavior. |
| src/frontend/src/content/docs/whats-new/aspire-13-4.mdx | Adjusts 13.4 release notes wording so “proxyless-by-default” applies to persistent executables/projects; adds note that persistent containers remain proxied-by-default. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
IEvangelist
deleted the
dapine/fix-persistent-container-endpoint-defaults-13-5
branch
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.
Reopens #1219 against
release/13.5after it was merged intorelease/13.4.Documents changes from microsoft/aspire#17960 by
@danegsta.Why this PR is needed
PR #17960 corrected a regression in Aspire 13.4 where persistent containers incorrectly defaulted to proxyless endpoints. The fix makes persistent containers behave like session containers — using proxied endpoints by default — while persistent executables and projects retain their proxyless-by-default behavior. The existing docs stated that all persistent resources default to proxyless endpoints, which is now incorrect for containers.
In addition, the PR restores the previous behavior for proxyless container endpoints that specify only a
targetPort: the target port is immediately used as the allocated host port, with no delayed allocation.Changes made
app-host/resource-lifetimes.mdx— Updated the persistent lifetime section to distinguish between containers (proxied by default) and executables/projects (proxyless by default). Added a note that proxyless container endpoints with only atargetPortimmediately allocate the target port as the host port.fundamentals/networking-overview.mdx— Corrected three locations:EndpointAnnotationproperties reference paragraphwhats-new/aspire-13-4.mdx— Corrected two locations in the persistent executable/project lifetime sections (feature spotlight Aside and breaking changes entry) to scope the proxyless-by-default statement to executables and projects only.Files modified
src/frontend/src/content/docs/app-host/resource-lifetimes.mdxsrc/frontend/src/content/docs/fundamentals/networking-overview.mdxsrc/frontend/src/content/docs/whats-new/aspire-13-4.mdx