Skip to content

[docs] Kubernetes Gateway TLS and FQDN auto-discovery - #799

Closed
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.3from
docs/kubernetes-tls-fqdn-discovery-dabe71f1e8af58e4
Closed

[docs] Kubernetes Gateway TLS and FQDN auto-discovery#799
aspire-repo-bot[bot] wants to merge 1 commit into
release/13.3from
docs/kubernetes-tls-fqdn-discovery-dabe71f1e8af58e4

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16585

Author: @aspire-repo-bot[bot] (backport of changes from @mitchdenny)

Targeting main — falling back to main because release/13.3 does not exist on microsoft/aspire.dev. The source PR milestone is 13.3.

Why this PR is needed

microsoft/aspire#16585 adds support for using WithTls(...) on a Kubernetes Gateway without calling WithHostname(...) first. Previously, TLS configuration required a known hostname upfront. Now, aspire deploy automatically discovers the hostname that the Gateway controller assigns after deployment (FQDN discovery), then patches the Gateway listener and HTTPRoutes so that cert-manager can issue a certificate using the HTTP-01 ACME solver.

The existing deployment/kubernetes.mdx had no documentation on Gateway TLS configuration at all. This PR adds a dedicated Configure Gateway TLS section covering all three WithTls patterns.

Summary of changes

Updated pages

  • src/frontend/src/content/docs/deployment/kubernetes.mdx — added a new "Configure Gateway TLS" section with:
    • TLS with a known hostname (WithHostname + WithTls)
    • TLS with FQDN auto-discovery (WithTls only, no WithHostname) — the new behavior from this PR
    • Auto-generated TLS secret names (WithTls() with no arguments)
    • Four-step explanation of the auto-discovery flow (deploy, wait for LB address, patch, cert-manager issues cert)
    • Note about requirements (cert-manager, HTTP-01 solver, a Gateway controller that allocates external addresses)
    • C# and TypeScript code examples for all three patterns

Files modified

  • src/frontend/src/content/docs/deployment/kubernetes.mdx (updated — 124 lines added)

Generated by PR Documentation Check for issue #16585 · ● 2.1M ·

Documents the new FQDN discovery capability introduced in
microsoft/aspire#16585 (backport of #16551 to release/13.3).

- Explains WithTls + WithHostname for known-hostname TLS
- Explains WithTls without WithHostname for FQDN auto-discovery
- Describes the four-step auto-discovery flow (deploy, wait, patch, cert)
- Documents WithTls() overload for auto-generated secret names
- Adds a note about requirements (cert-manager, HTTP-01 solver)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist
David Pine (IEvangelist) force-pushed the docs/kubernetes-tls-fqdn-discovery-dabe71f1e8af58e4 branch from fbeb687 to 7994623 Compare May 4, 2026 14:26
@IEvangelist
David Pine (IEvangelist) changed the base branch from main to release/13.3 May 4, 2026 14:26
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review May 4, 2026 18:02
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.

1 participant