delete-o11y-hosted-zone - #23472
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
contribution
📝 WalkthroughWalkthroughBYOC documentation now describes a single TiDB Route 53 hosted zone that can be public or private. It removes O11Y hosted-zone parameters from IAM, environment preparation, and multi-region procedures. It also documents the connection type required for each hosted-zone type. ChangesBYOC hosted zone guidance
Estimated code review effort: 2 (Simple) | ~10 minutes Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro Plus
Run ID: b839b63b-e87c-4af2-ad8c-9e82a82fcc86
📒 Files selected for processing (5)
tidb-cloud/byoc/byoc-configure-iam-permissions.mdtidb-cloud/byoc/byoc-onboarding-overview.mdtidb-cloud/byoc/byoc-prepare-environment-aws.mdtidb-cloud/byoc/multi-region-deployment.mdtidb-cloud/premium/connect-to-premium-via-public-connection.md
💤 Files with no reviewable changes (1)
- tidb-cloud/byoc/byoc-configure-iam-permissions.md
| For a public hosted zone, delegate the zone from its parent domain by adding the Route 53 name server (NS) records to the parent DNS configuration. For a private hosted zone, associate the hosted zone with the VPCs that require DNS resolution. | ||
|
|
||
| - **Observability (O11y) Zone:** Manages DNS for monitoring tools (Grafana/Prometheus). | ||
|
|
||
| * Naming Constraint: Max 34 characters. | ||
| * Example: `o11y.cluster.example.com`. | ||
|
|
||
| 2. **Delegate DNS.** | ||
|
|
||
| > **Important:** | ||
| > | ||
| > **DNS Delegation Required.** After creating the hosted zones, you **must** add Route 53 Name Servers (NS records) to your parent domain's DNS configuration (for example, in your corporate DNS or parent AWS zone). | ||
|
|
||
| - **Action:** Copy the 4 NS records from your new Route 53 zones and add them to the parent domain. | ||
| - **Result:** Without this, internal service discovery will fail. | ||
|
|
||
| 3. **Verify the DNS delegation.** | ||
|
|
||
| Verify the DNS delegation by running `nslookup` or `dig` from any internet-connected command-line environment. The domain must resolve correctly. | ||
|
|
||
| ```bash | ||
| nslookup -type=ns {hosted_zone_name} | ||
| nslookup -type=ns byoc-tidb.cluster.example.com | ||
| nslookup -type=ns o11y.cluster.example.com | ||
| ``` | ||
|
|
||
| <!--To confirm: whether to add image--> | ||
|
|
||
| > **Note:** | ||
| > | ||
| > If you plan to deploy TiDB Cloud BYOC in **multiple AWS regions**, the same hosted zones can be shared across all regions, or you can choose to create dedicated hosted zones per region. See [Multi-Region Deployment](/tidb-cloud/byoc/multi-region-deployment.md) for detailed multi-region architecture configurations. | ||
| > **Note:** | ||
| > | ||
| > If you plan to deploy TiDB Cloud BYOC in multiple AWS Regions, you can share the same TiDB hosted zone across all regions or use a dedicated hosted zone for each region. See [Multi-Region Deployment](/tidb-cloud/byoc/multi-region-deployment.md) for details. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Files:"
git ls-files | rg '(^|/)byoc-prepare-environment-aws\.md$|(^|/)byoc-onboarding-overview\.md$|(^|/)multi-region-deployment\.md$|resources/doc-templates' || true
echo
echo "Target file excerpt:"
if [ -f tidb-cloud/byoc/byoc-prepare-environment-aws.md ]; then
cat -n tidb-cloud/byoc/byoc-prepare-environment-aws.md | sed -n '1,120p'
fi
echo
echo "Overview file excerpt:"
if [ -f tidb-cloud/byoc/byoc-onboarding-overview.md ]; then
cat -n tidb-cloud/byoc/byoc-onboarding-overview.md | sed -n '1,80p'
fi
echo
echo "Search relevant terms:"
rg -n -i "private hosted zone|associate|name server|NS|Route 53|hosted zone|provisioned|Phase 3|VPC" tidb-cloud/byoc resources/doc-templates || trueRepository: pingcap/docs
Length of output: 50368
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Byoc automated deployment excerpts:"
if [ -f tidb-cloud/byoc/byoc-automated-deployment.md ]; then
wc -l tidb-cloud/byoc/byoc-automated-deployment.md
cat -n tidb-cloud/byoc/byoc-automated-deployment.md | sed -n '1,240p'
fi
echo
echo "IAM script/config references to hosted zones:"
rg -n -i "Hosted Zone|HostedZone|hostedZone|Hosted Zone Id|HostedZoneId|TiDBHostedZone|TiDB hosted zone|Route53|route53|associate|VPC|VPCTiDB|Private Zone" tidb-cloud/byoc/byoc-configure-iam-permissions.md tidb-cloud/byoc/*.md || true
echo
echo "Search for automation/vpc/private-hosted-zone keywords in scripts/docs:"
rg -n -i "auto-deploy|create-.*vpc|route-53|private hosted zone|private-hosted|associate-hosted-zone|vpc-association|VPC Association" . --glob '!**/node_modules/**' --glob '!**/build/**' --glob '!**/dist/**' | head -n 200Repository: pingcap/docs
Length of output: 23208
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "Check for Route 53 hosted-zone scripts/templates:"
fd -a . . | rg -i 'hosted|route53|byoc|terraform|cloudformation|stack|setup|update|deploy|byoc-configure-iam-permissions' | sed 's#^\./##' | head -n 300
echo
echo "Search repository-wide for hosted zone association text (focused):"
rg -n -i "associate.*hosted zone|hosted zone.*associate|HostedZoneAssociations|hosted_zone_associations|CreateHostedZone|CreateVpcAssociation|VPCAssociation|hosted zone id" . --glob '!**/node_modules/**' --glob '!**/build/**' --glob '!**/dist/**' --glob '!**/.git/**' | head -n 300
echo
echo "Inspect relevant BYOC IAM/prepare file sizes and key references:"
wc -l tidb-cloud/byoc/byoc-prepare-environment-aws.md tidb-cloud/byoc/byoc-configure-iam-permissions.mdRepository: pingcap/docs
Length of output: 10860
Document the private hosted-zone association step.
The private hosted zone option says users must associate the zone with VPCs, but the BYOC VPC is provisioned later in Phase 3 and this step only asks customers to create/configure the hosted zone. Clarify when the TiDB cluster VPC exists, who performs the Route 53 VPC association, and whether cross-account association is supported or requires TiDB Cloud assistance.
🧰 Tools
🪛 LanguageTool
[style] ~55-~55: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ecords to the parent DNS configuration. For a private hosted zone, associate the ho...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
1 participant
First-time contributors' checklist
What is changed, added or deleted? (Required)
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit