Skip to content

[docs] Add Podman support for Docker Compose deployment#764

Draft
aspire-repo-bot[bot] wants to merge 1 commit intorelease/13.3from
docs/podman-compose-support-16074-48c915d4f1d5e5f2
Draft

[docs] Add Podman support for Docker Compose deployment#764
aspire-repo-bot[bot] wants to merge 1 commit intorelease/13.3from
docs/podman-compose-support-16074-48c915d4f1d5e5f2

Conversation

@aspire-repo-bot
Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16074

Author: @davidfowl

Target branch: release/13.3 — chosen based on the source PR milestone 13.3.

Why this PR is needed

PR microsoft/aspire#16074 added first-class Podman support for Docker Compose deployments, introduced a new IContainerRuntimeResolver abstraction, and improved aspire doctor multi-runtime reporting. The existing docs only referenced Docker; Podman users and extension authors need updated guidance.

Summary of changes

deployment/docker-compose.mdx

  • Updated description to mention Docker and Podman as supported runtimes.
  • Added a new Container runtime support section explaining:
    • Auto-detection logic (parallel probe, prefer running, Docker as tiebreaker)
    • Podman-specific behavior (podman-compose / podman ps --filter label=... service discovery)
    • Tip pointing to aspire doctor for runtime diagnostics
  • Added a Breaking change section documenting the IContainerRuntimeIContainerRuntimeResolver API change with before/after code examples.
  • Added aspire doctor to the See also links.

reference/cli/commands/aspire-doctor.mdx

  • Updated the container checks bullet to describe the new multi-runtime reporting (status, version, which runtime is active and why).
  • Updated sample output to show the improved output: all detected runtimes listed with version, running status, and which is active and why.

Files modified

  • src/frontend/src/content/docs/deployment/docker-compose.mdx (updated)
  • src/frontend/src/content/docs/reference/cli/commands/aspire-doctor.mdx (updated)

Note: This draft PR needs human review before merging — in particular, the aspire doctor sample output should be verified against the actual CLI output once a staging build is available.

Generated by PR Documentation Check · ● 761.3K ·

- Document Podman as a supported container runtime for Docker Compose deploys
- Describe auto-detection logic (parallel probe, prefer running, Docker tiebreaker)
- Add Podman-specific behavior note (podman-compose / service discovery)
- Document breaking change: IContainerRuntime → IContainerRuntimeResolver
- Update aspire doctor docs to reflect multi-runtime reporting

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@aspire-repo-bot aspire-repo-bot Bot added the docs-from-code Copilot initiated issue from dotnet/aspire repo label Apr 28, 2026
@joperezr
Copy link
Copy Markdown
Member

@davidfowl please take a look


This workflow checks out your code, sets up .NET and installs the Aspire CLI, authenticates to GHCR using the built-in `GITHUB_TOKEN`, and builds and pushes container images using `aspire do push`.

## Breaking change: IContainerRuntime → IContainerRuntimeResolver
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.

Remove this from this document

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.

2 participants