Skip to content

[docs] Document container tunnel base image configuration - #1809

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20667-36968575513-1-e6e94e38e558f44b
Closed

aspire-repo-bot[bot] wants to merge 1 commit into
release/17.0from
docs/pr-20667-36968575513-1-e6e94e38e558f44b

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#20667

@danegsta

Target branch: Targeting release/17.0 based on the source PR milestone 17.0 (exact match found on microsoft/aspire.dev).

Why this is needed

microsoft/aspire#20667 added user-facing Aspire CLI/AppHost configuration to override the base image used by the DCP container network tunnel, but the docs site didn't describe the new containerTunnel.baseImage setting, its projected ASPIRE_CONTAINER_TUNNEL_BASE_IMAGE environment variable, or the AppHost-level --dcp-container-tunnel-base-image argument / DcpPublisher:ContainerTunnelBaseImage configuration key.

Triggered signal: pr_body_has_cli_flag_mention — the PR body mentions --dcp-container-tunnel-base-image.

What changed

  • reference/cli/configuration.mdx: Added a "Configure the container tunnel base image" subsection under "Settings surfaced by aspire config", with an aspire config set containerTunnel.baseImage example.com/aspire-tunnel:configured example and an explanation of how the value is projected to .NET and polyglot AppHosts, plus the precedence rules relative to explicit AppHost configuration.
  • reference/cli/includes/config-settings-table.md: Added a containerTunnel.baseImage row to the settings table.
  • app-host/configuration.mdx: Added a ContainerTunnelBaseImage subsection under "Advanced orchestration properties", documenting all four ways to set it (Aspire CLI config, --dcp-container-tunnel-base-image, DcpPublisher:ContainerTunnelBaseImage, and the ASPIRE_CONTAINER_TUNNEL_BASE_IMAGE environment variable) and when to use it.
  • fundamentals/container-networking.mdx: Added a short "Configure the container tunnel base image" section (next to the existing "Disable the container tunnel" section) with a cross-reference to the new AppHost configuration reference subsection.

Files modified

  • src/frontend/src/content/docs/app-host/configuration.mdx (updated)
  • src/frontend/src/content/docs/fundamentals/container-networking.mdx (updated)
  • src/frontend/src/content/docs/reference/cli/configuration.mdx (updated)
  • src/frontend/src/content/docs/reference/cli/includes/config-settings-table.md (updated)

No new pages were created; all changes update existing documentation pages.

Generated by PR Documentation Check for #20667 · copilot · auto · 81.6 AIC · ⌖ 10.8 AIC · ⊞ 20.3K · ◷

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 Oct 2, 2026
@aspire-repo-bot

Copy link
Copy Markdown
Contributor Author

Frontend HTML artifact ready

The latest frontend build uploaded the frontend-dist artifact for PR #1809. Use the VS Code button below to open this PR with GitHub Artifacts Explorer and browse the built HTML locally.

VS Code: Open PR #1809 artifacts

This comment updates automatically when a new frontend build artifact is uploaded.

Copy link
Copy Markdown
Member

docs-pr-reviewer report — [partial — phase A: key claims evaluated; phase B: not run (docs site was not served in this automated run)]

Recommendation: approve

Source used: microsoft/aspire#20667 (merged 2026-10-02)
PR status: draft, merge conflicts with base, bot-authored, opened 2026-10-02 — STALE (~32 days); 4 files.

Phase A — claims

  • ✅ verified: containerTunnel.baseImage (CLI config projector) and --dcp-container-tunnel-base-image (DistributedApplicationBuilder) exist; DcpPublisher:ContainerTunnelBaseImage per source PR.
  • Rebase required before merge.

Phase B — doc-tester

Not run; rendering of the changed pages is not browser-checked.

🤖 Posted by aspire.dev - squad (AI Agent)

@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review November 13, 2026 14:59
Copilot AI balanced review requested due to automatic review settings November 13, 2026 14:59

Copilot AI left a comment

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.

🔵 Needs a closer look

Required browser and CLI validation was blocked by missing dependencies and environment restrictions, leaving rendered documentation and tunnel startup unverified.

No open issues 🎉

What changed in this PR

Documents the container tunnel base image configuration introduced in microsoft/aspire#20667, connecting CLI settings with the AppHost reference and container networking guide.

Changes:

  • Adds containerTunnel.baseImage to the CLI settings reference with a configuration example.
  • Explains environment-variable projection, AppHost override options, and configuration precedence.
  • Describes use cases for customized or mirrored images and links the networking guide to the AppHost reference.
File Description
src/​frontend/​src/​content/​docs/​reference/​cli/​includes/​config-settings-table.md Adds the container tunnel base image setting.
src/​frontend/​src/​content/​docs/​reference/​cli/​configuration.mdx Documents CLI usage, environment projection, and precedence.
src/​frontend/​src/​content/​docs/​fundamentals/​container-networking.mdx Adds a configuration example and reference link.
src/​frontend/​src/​content/​docs/​app-host/​configuration.mdx Documents override methods, precedence, and use cases.

Review effort: Balanced

David Pine (IEvangelist) added a commit that referenced this pull request Nov 17, 2026
## Summary

Consolidates the open `docs-from-code` PRs that cover features from
@IEvangelist's product work or that request their review, all targeting
`release/17.0`, into this single PR. Each PR was checked against its
merged microsoft/aspire source PR and against product `release/17.0`, to
confirm the change shipped in 17.0 and is user-facing rather than an
implementation detail. Accepted text was corrected where the bot's
wording was inaccurate.

| PR(s) | Verdict | Notes |
| --- | --- | --- |
| #2103, #2098, #1967, #2073, #2070 | Accepted with fixes | Go AppHost
conventions, `aspire init`, and VS Code extension. Unrelated e2e test
edits from #2073 were dropped. |
| #1972 | Partially accepted | Only the verified behavior was kept. |
| #2069, #2064, #1829 | Accepted with fixes | Dashboard explore page and
`aspire describe --format Mermaid` |
| #2044 | Partially accepted | The Cards/Home/Graph layout selector text
is outdated, so it was dropped. |
| #1959, #1904, #1835, #1801 | Accepted with fixes | `WithTerminal`
options, the dashboard terminal UX, and TypeScript `configure` |
| #1902 | Accepted with fixes | `dotnet run --operation publish`
guidance |
| #2081 | Accepted with fixes | WSLc limited publish support. The
minimum version is corrected to 3.0.4.0. |
| #2014, #1862, #1809, #1936, #2140, #1997, #2051, #2068, #2022, #1963 |
Accepted with fixes | DCP timeouts, the container tunnel base image,
browser origins, the PVC `WithConfiguration` API, the interaction
service caution, secrets, `aspire update`, and agent init telemetry |
| #2092 | Rejected | Documents implementation details. |
| #2078 | Rejected | Already documented correctly; the proposed text was
wrong. |
| #2110, #2104, #2085, #2094 | Rejected | The product change isn't in
`release/17.0`; it's 17.1-only. Redo these against the next release
branch. |
| #2133 | Rejected for now | Its backport, microsoft/aspire#22219, is
still open, so redo this once it merges. |

Additional consistency fixes:

- **WSLc:** the minimum version is now 3.0.4.0, the source's
`MinimumWslcVersion`, across prerequisites, `aspire doctor`,
configuration, and what's new. The pages now describe limited publish
support and state that Docker Compose isn't supported.
- **`WithTerminal`:** `WithTerminal` and `TerminalOptions` are no longer
`[Experimental]` in 17.0. I removed the stale `ASPIRETERMINAL001`
pragmas and cautions and rewrote the diagnostic page to cover the
terminal APIs that are still experimental.

Closes #2140
Closes #2133
Closes #2110
Closes #2104
Closes #2103
Closes #2098
Closes #2094
Closes #2092
Closes #2085
Closes #2081
Closes #2078
Closes #2073
Closes #2070
Closes #2069
Closes #2068
Closes #2064
Closes #2051
Closes #2044
Closes #2022
Closes #2014
Closes #1997
Closes #1972
Closes #1967
Closes #1963
Closes #1959
Closes #1936
Closes #1904
Closes #1902
Closes #1862
Closes #1835
Closes #1829
Closes #1809
Closes #1801

## Third-party links and affiliations

None. The only added external link is to mermaid.js.org, which the page
already links elsewhere.

## Validation

- I compared each claim with the merged microsoft/aspire source and
checked that it's included in product `release/17.0`, using `gh api
compare` and searches for backport PRs.
- I checked the TypeScript sample against the generated `aspire.d.ts`.
`EndpointReferenceExpression` is an `IValueProvider`.
- I reviewed the full diff by hand for MDX and table formatting,
imports, and anchors. The new `seoTitle` is 58 characters.
- I didn't run any local unit, e2e, or build commands because frontend
dependencies aren't installed locally. CI covers the build, unit, and
e2e checks, including the updated `custom-components.spec.ts` assertion.

---------

Co-authored-by: David Pine <7679720+IEvangelist@users.noreply.github.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@alistairmatthews

Copy link
Copy Markdown
Collaborator

Superseded by #2189 (merged to release/17.0)

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.

3 participants