Skip to content

[docs] Gateway API TLS and FQDN auto-discovery for Kubernetes deployment - #782

Closed
aspire-repo-bot[bot] wants to merge 2 commits into
release/13.3from
docs/aspire-16551-gateway-tls-fqdn-discovery-5ce08194c3927301
Closed

[docs] Gateway API TLS and FQDN auto-discovery for Kubernetes deployment#782
aspire-repo-bot[bot] wants to merge 2 commits into
release/13.3from
docs/aspire-16551-gateway-tls-fqdn-discovery-5ce08194c3927301

Conversation

@aspire-repo-bot

Copy link
Copy Markdown
Contributor

Documents changes from microsoft/aspire#16551.

@mitchdenny

Target branch: main — falling back to main because release/13.4 (resolved from the PR milestone 13.4) does not yet exist on microsoft/aspire.dev.

Why this PR is needed

PR microsoft/aspire#16551 adds support for Kubernetes Gateway API TLS configuration without a pre-known hostname. When WithTls() is called without WithHostname(), a new tls-fqdn-discovery pipeline step automatically discovers the FQDN assigned by the gateway controller (e.g., Azure AGC), patches the listener, and bootstraps TLS — enabling single-deploy TLS for controllers that assign FQDNs dynamically.

The existing deployment/kubernetes.mdx page had no documentation for the Gateway API, routing, or TLS at all. This is a significant user-facing feature gap.

What was changed

Updated src/frontend/src/content/docs/deployment/kubernetes.mdx with a new "Configure Gateway API and TLS" section covering:

  • Basic Gateway with routesAddGateway, WithGatewayClass, WithRoute (C# and TypeScript examples)
  • TLS with a known hostnameWithHostname + WithTls pattern
  • TLS with FQDN auto-discovery — calling WithTls() without WithHostname(), including an explanation of the tls-fqdn-discovery pipeline step sequence and its 5-minute polling behavior

Files modified

  • src/frontend/src/content/docs/deployment/kubernetes.mdx (updated — new section added)

This draft PR needs human review before merging.

Generated by PR Documentation Check for issue #16551 · ● 1.7M ·

… deployment

Documents the new FQDN auto-discovery behavior introduced in microsoft/aspire#16551.
When WithTls() is called without WithHostname(), a tls-fqdn-discovery pipeline
step discovers the controller-assigned FQDN after Helm deploy and patches the
Gateway listener hostname automatically. Also documents basic Gateway usage and
the known-hostname TLS pattern for completeness.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@IEvangelist
David Pine (IEvangelist) force-pushed the docs/aspire-16551-gateway-tls-fqdn-discovery-5ce08194c3927301 branch from 796bea3 to f81026e Compare April 30, 2026 14:00
@IEvangelist
David Pine (IEvangelist) changed the base branch from main to release/13.3 April 30, 2026 14:00
@IEvangelist
David Pine (IEvangelist) marked this pull request as ready for review April 30, 2026 15:21
Comment thread src/frontend/src/content/docs/deployment/kubernetes.mdx
Co-authored-by: David Pine <david.pine@microsoft.com>
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