[docs] Document aspire stop socket cleanup for detached AppHosts#1283
Open
aspire-repo-bot[bot] wants to merge 1 commit into
Open
[docs] Document aspire stop socket cleanup for detached AppHosts#1283aspire-repo-bot[bot] wants to merge 1 commit into
aspire-repo-bot[bot] wants to merge 1 commit into
Conversation
After aspire stop confirms the AppHost process has terminated, it now removes the backchannel socket file. This prevents stale-socket errors when running subsequent commands (aspire add, aspire describe, etc.) after the stop/detach workflow. Documents the fix from microsoft/aspire#18296 (fixes #17587). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aspire-repo-bot
Bot
added
the
docs-from-code
Contributor
Author
Frontend HTML artifact readyThe latest frontend build uploaded the This comment updates automatically when a new frontend build artifact is uploaded. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Aspire CLI reference docs for aspire stop to explain the socket cleanup behavior when stopping a detached AppHost, reflecting the behavior change introduced in microsoft/aspire#18296.
Changes:
- Added a new Stopping a detached AppHost subsection to
aspire stopdocumentation. - Documented that
aspire stopremoves the backchannel socket file after the detached AppHost process terminates to prevent stale-connection failures in subsequent CLI commands.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -29,6 +29,10 @@ When executed without the `--apphost` option, the command: | |||
|
|
|||
| The command sends a stop signal to the CLI process that started the AppHost, which ensures a clean shutdown of all resources including the dashboard and any containers or processes that were started. | |||
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.
Documents changes from microsoft/aspire#18296 by
@mitchdenny.Targeting
release/13.5based on the source PR milestone13.5.Why this PR is needed
PR microsoft/aspire#18296 fixed a bug (#17587) where
aspire stopdid not clean up the backchannel socket file after confirming the AppHost process had terminated. The stale socket caused subsequent CLI commands (aspire add,aspire describe, etc.) to discover the dead socket and fail with connection-timeout errors. This was especially noticeable on Windows where PID reuse could cause the orphan-pruning heuristic to believe the dead process was still alive.The fix adds explicit socket-file deletion in
StopCommandandRunningInstanceManager.StopRunningInstanceAsynconce the AppHost process is confirmed stopped. Users can now reliably follow theaspire run --detach→aspire stop→ subsequent command workflow without stale-socket errors.Documentation changes
Updated
aspire-stop.mdxto document this socket cleanup behavior under a new Stopping a detached AppHost subsection, so users understand that the cleanup happens automatically.Files modified
src/frontend/src/content/docs/reference/cli/commands/aspire-stop.mdx— added subsection describing socket file cleanup after stopping a detached AppHost