Skip to content

byoc: update CIDR descriptions - #24515

Open
wildpcww wants to merge 4 commits into
pingcap:release-8.5from
wildpcww:updateo11ycidr
Open

wildpcww wants to merge 4 commits into
pingcap:release-8.5from
wildpcww:updateo11ycidr

Conversation

@wildpcww

@wildpcww wildpcww commented Oct 21, 2026 •

Copy link
Copy Markdown
Collaborator

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.

  • master (the latest development version)
  • v9.0 (TiDB 9.0 versions)
  • v8.5 (TiDB 8.5 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)

What is the related PR or file link(s)?

  • Related code change PR links (if applicable):
  • This PR is translated from:
  • Other reference link(s):

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

Summary by CodeRabbit

  • Documentation
    • Updated BYOC observability and resource pool guidance to specify supported CIDR prefix lengths of /16–/20.
    • Clarified AWS requirements and IAM role tagging steps for importing BYOC instances during Premium migration.
    • Updated TiCDC connectivity guidance to cover public connections and AWS PrivateLink, including the public hosted zone requirement and where to find connection details.

@ti-chi-bot ti-chi-bot Bot added contribution This PR is from a community contributor. missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 21, 2026
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 6b5cb16 and 1420dc9.

Files selected for processing: 1
  • tidb-cloud/premium/migrate-from-op-tidb-premium.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Walkthrough

The BYOC documentation narrows the permitted CIDR prefix range and updates O11Y examples. The Premium migration guide clarifies AWS targets, adds BYOC IAM role tagging requirements, and updates TiCDC connection setup instructions.

Changes: Migration Guide for Premium and BYOC

Layer / File(s) Summary
Migration scope and IAM requirements
tidb-cloud/premium/migrate-from-op-tidb-premium.md
The guide clarifies that the Premium or BYOC instances are on AWS. It adds the tidbcloud.com/allow-dataplane-access=true tag requirement for BYOC roles created through CloudFormation or manually.
TiCDC connectivity
tidb-cloud/premium/migrate-from-op-tidb-premium.md
The guide replaces public-IP allowlist instructions with public connection or AWS PrivateLink setup. For BYOC, it specifies that public connections require a public hosted zone and directs users to use the configured connection type’s host and port.

BYOC CIDR Guidance

Layer / File(s) Summary
CIDR planning requirements
tidb-cloud/byoc/byoc-prepare-environment-aws.md, tidb-cloud/byoc/create-resource-pool-byoc.md
The guides set the permitted CIDR prefix range to /16–/20. The O11Y examples change to 10.1.0.0/20.

Priority: Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Suggested reviewers: lilin90, alastori

Merge Risk: Minimal · up to 1420d

The documentation changes are consistent and no actionable merge-blocking risk remains.

Security architecture risk: Low · up to 199ca

The changes update operational guidance rather than deployed infrastructure. The referenced instructions retain IP filtering, private connectivity controls and scoped import permissions. No introduced security failure was established, but BYOC transport security, effective IAM enforcement and failure-recovery behavior remain unverified.

Retained concerns
No architecture-level concerns identified.

Security review details

Security Blast Radius

  • inferred — The migration handles source data in S3 and writes to the selected downstream instance. Effective exposure depends on the supplied IAM permissions, SQL identity and endpoint restrictions; the documentation does not establish an organization-wide privilege expansion or prove runtime tenant isolation.

Trust Boundaries and Controls

  • observed — The linked public guide requires an IP access list for both Premium and BYOC. Its configuration guide recommends explicit IP/CIDR entries and warns that allowing access from anywhere is highly risky. Delegating to this guide does not remove the documented source-filtering prerequisite.
  • observed — The PrivateLink guide restricts endpoint creation to owner roles, requires a same-region endpoint and target, calls for an appropriate security group, and directs users to connect through an active endpoint with a root password configured.

Resilience and Maintainability Implications

  • observed — The existing normal-path safeguards remain: use the full-export metadata start time, restore GC after replication starts without error or delay, inspect changefeed state and verify a replicated write. These steps do not establish safe recovery from interrupted or repeated migrations.

Hardening Proposals

  • proposed — Make the BYOC TiCDC authentication, TLS and certificate parameters explicit, and identify ownership for migration-credential cleanup and interrupted-migration recovery. These are follow-up hardening proposals, not verified vulnerabilities introduced by this PR.
Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Description check Warning The description follows the template and selects v8.5, but it leaves the required change summary empty and provides no related links. It does not explain the CIDR updates or the migration guide change… Add a concise summary of all documentation changes and their purpose. Include related PR or reference links if applicable.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title clearly identifies the main CIDR documentation update. It does not mention the migration guide changes, but it remains specific and related to the primary change.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Full details: Description check

Explanation

The description follows the template and selects v8.5, but it leaves the required change summary empty and provides no related links. It does not explain the CIDR updates or the migration guide changes.

Resolution

Add a concise summary of all documentation changes and their purpose. Include related PR or reference links if applicable.

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: b5553755-abe4-4939-b5c9-d5c08de4174d
📥 Commits

Reviewing files that changed from the base of the PR and between 0960761 and 199ca0d.

📒 Files selected for processing: 5
  • TOC-tidb-cloud-byoc.md
  • TOC-tidb-cloud-premium.md
  • tidb-cloud/byoc/byoc-prepare-environment-aws.md
  • tidb-cloud/byoc/create-resource-pool-byoc.md
  • tidb-cloud/premium/migrate-from-op-tidb-premium.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread tidb-cloud/premium/migrate-from-op-tidb-premium.md Outdated
@lilin90 lilin90 self-assigned this Oct 23, 2026
@lilin90 lilin90 added the translation/no-need No need to translate this PR. label Oct 23, 2026
@ti-chi-bot ti-chi-bot Bot removed the missing-translation-status This PR does not have translation status info. label Oct 23, 2026
@lilin90 lilin90 changed the title cidr update byoc: update CIDR descriptions Oct 23, 2026
@lilin90 lilin90 added the BYOC Related to TiDB Cloud BYOC docs. label Oct 23, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 26, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 26, 2026
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

BYOC Related to TiDB Cloud BYOC docs. contribution This PR is from a community contributor. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants