Skip to content

cloud: document IPv6 support for Dedicated private endpoint connections - #23904

Open
xboxeer wants to merge 6 commits into
pingcap:release-8.5from
xboxeer:dedicated-private-endpoint-ipv6
Open

xboxeer wants to merge 6 commits into
pingcap:release-8.5from
xboxeer:dedicated-private-endpoint-ipv6

Conversation

@xboxeer

@xboxeer xboxeer commented Sep 20, 2026

Copy link
Copy Markdown
Collaborator

What is changed, added or deleted? (Required)

Document inbound IPv6 support for TiDB Cloud Dedicated private endpoint connections over AWS PrivateLink:

  • tidb-cloud/set-up-private-endpoint-connections.md: add a "Use IPv6 connectivity over a private endpoint" section, which covers:
    • inbound IPv6 access over AWS PrivateLink is enabled on request through PingCAP Technical Support;
    • the IP protocol type is configured per node group and can only be changed after the cluster is created (on the cluster's Networking page, click Edit in the AWS Private Endpoints panel and select Dual Stack (IPv4 + IPv6));
    • creating an AWS interface endpoint with the Dualstack IP address type, including the --ip-address-type dualstack flag to append to the generated AWS CLI command;
    • switching the IP protocol type back to IPv4 Only requires deleting all private endpoints that use IPv6 connectivity first.

Which TiDB version(s) do your changes apply to? (Required)

  • 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)?

  • 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
    • Added instructions for using IPv6 connectivity with private endpoint connections.
    • Documented how to enable IPv6 support and create an AWS interface endpoint with Dualstack IP addressing.
    • Clarified that selected subnets must include both IPv4 and IPv6 CIDR blocks.
    • Added steps for completing the private endpoint connection and connecting over IPv6.

@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 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 assign kissmydb for approval. 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 missing-translation-status This PR does not have translation status info. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 20, 2026
@coderabbitai

coderabbitai Bot commented Sep 20, 2026

Copy link
Copy Markdown

Review Change StackReview 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

Configuration used: Repository: pingcap/docs/.coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 418ef707-853a-44b3-be25-dd35ea290f32

📥 Commits

Reviewing files that changed from the base of the PR and between 24907da and 5938db8.

📒 Files selected for processing (1)
  • tidb-cloud/set-up-private-endpoint-connections.md

Included review availability: Your plan provides up to 4 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

The private endpoint guide now documents IPv6 connectivity over AWS PrivateLink, including IPv6 enablement, dual-stack endpoint configuration, subnet requirements, and connection steps.

Changes

IPv6 private endpoint connectivity

Layer / File(s) Summary
Document IPv6 endpoint configuration
tidb-cloud/set-up-private-endpoint-connections.md
Documents IPv6 enablement through PingCAP Technical Support and dual-stack configuration for private endpoint connections.
Document IPv6 interface endpoint creation
tidb-cloud/set-up-private-endpoint-connections.md
Documents the Dualstack setting, dual-stack subnet requirements, the AWS CLI option, and the remaining connection steps.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Title check ✅ Passed The title clearly and concisely describes the main change: documenting IPv6 support for Dedicated private endpoint connections.
Description check ✅ Passed The description explains the documentation changes, identifies the affected TiDB version, records AI involvement, and addresses the applicable template sections. The omitted first-time contributor che…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR

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: 345ac184-6735-475b-a663-910259fd5e13

📥 Commits

Reviewing files that changed from the base of the PR and between 743161b and 867240f.

📒 Files selected for processing (1)
  • tidb-cloud/set-up-private-endpoint-connections.md

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

Comment thread tidb-cloud/set-up-private-endpoint-connections.md Outdated
@ti-chi-bot ti-chi-bot Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 20, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 20, 2026

Copy link
Copy Markdown

@ZatoChen: adding LGTM is restricted to approvers and reviewers in OWNERS files.

Details

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@qiancai qiancai self-assigned this Sep 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants