Skip to content

docs: use CNAME for Connect DNS configuration#4750

Open
drernie wants to merge 4 commits intomasterfrom
docs-connect-cname-cross-account
Open

docs: use CNAME for Connect DNS configuration#4750
drernie wants to merge 4 commits intomasterfrom
docs-connect-cname-cross-account

Conversation

@drernie
Copy link
Copy Markdown
Member

@drernie drernie commented Mar 4, 2026

Summary

  • Replace the Route 53-specific alias A record instructions with a simple CNAME pointing to ConnectLoadBalancerDNSName
  • CNAME works universally, including when Route 53 is in a different AWS account than the Quilt stack

Test plan

  • Review docs render correctly

🤖 Generated with Claude Code

Greptile Summary

This PR simplifies the DNS configuration documentation for Quilt Connect Server by replacing the Route 53-specific alias A record setup (which required both ConnectLoadBalancerDNSName and ConnectLoadBalancerCanonicalHostedZoneID) with a single, universally compatible CNAME record pointing to ConnectLoadBalancerDNSName.

Key changes:

  • Removes the Route 53-specific DNS table (record type A/alias, alias target, hosted zone ID fields)
  • Replaces it with a concise prose instruction to create a CNAME pointing to ConnectLoadBalancerDNSName
  • The ConnectHost output reference is preserved
  • The simplification directly supports cross-account deployments where Route 53 may not be in the same AWS account as the Quilt stack

Confidence Score: 5/5

  • This PR is safe to merge — it is a documentation-only change with no code impact.
  • The change is purely documentation, technically accurate (CNAME to an ELB DNS name is valid for subdomains and works across all DNS providers), and the Connect subdomain pattern (<stack-name>-connect.<your-domain>) is always a subdomain, so the CNAME restriction on zone-apex records is not a concern here.
  • No files require special attention.

Important Files Changed

Filename Overview
docs/Catalog/Connect.md Documentation-only change replacing the Route 53-specific alias A record DNS setup table with a concise CNAME instruction that works universally across DNS providers and AWS accounts.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Deploy Quilt Stack\nwith ConnectAllowedHosts set"] --> B["CloudFormation Outputs Available:\n• ConnectLoadBalancerDNSName\n• ConnectHost"]
    B --> C["Create DNS CNAME Record\n(any DNS provider / any AWS account)"]
    C --> D["CNAME: <stack>-connect.<domain>\n→ ConnectLoadBalancerDNSName"]
    D --> E["Connect Server reachable at\nConnectHost URL"]
    E --> F["AI clients (Claude.ai, etc.)\ncan integrate via MCP"]
Loading

Last reviewed commit: c3d6b50

CNAME works universally regardless of AWS account boundaries,
unlike Route 53 alias A records which are account-specific.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@drernie drernie self-assigned this Mar 4, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 44.32%. Comparing base (dd654ce) to head (a6c1959).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #4750   +/-   ##
=======================================
  Coverage   44.32%   44.32%           
=======================================
  Files         813      813           
  Lines       32734    32734           
  Branches     5722     5722           
=======================================
  Hits        14509    14509           
  Misses      16221    16221           
  Partials     2004     2004           
Flag Coverage Δ
api-python 92.65% <ø> (ø)
catalog 19.52% <ø> (ø)
lambda 96.63% <ø> (ø)
py-shared 98.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@drernie drernie requested a review from sir-sigurd March 4, 2026 02:31
@drernie drernie enabled auto-merge March 4, 2026 02:31
Copy link
Copy Markdown
Member

@sir-sigurd sir-sigurd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I think alias is preferred when you use Route53, check that claim with AI if so let's mention both
  2. maybe we should cross-reference with https://docs.quilt.bio/quilt-platform-administrator/installation#cnames?

drernie and others added 3 commits March 4, 2026 09:08
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants