Skip to content

cloud: clarify serverless private endpoint VPC scope#22849

Open
qiancai wants to merge 3 commits intopingcap:release-8.5from
qiancai:fix-serverless-private-endpoint-vpc-scope
Open

cloud: clarify serverless private endpoint VPC scope#22849
qiancai wants to merge 3 commits intopingcap:release-8.5from
qiancai:fix-serverless-private-endpoint-vpc-scope

Conversation

@qiancai
Copy link
Copy Markdown
Collaborator

@qiancai qiancai commented May 6, 2026

What is changed, added or deleted? (Required)

Clarify the customer-side scope of private endpoints for TiDB Cloud Starter or Essential instances over AWS PrivateLink:

  • Clarify that for each VPC in an AWS Region, one private endpoint is enough for all Starter or Essential instances in that Region from the same VPC.
  • Clarify that private endpoints cannot be shared across VPCs.
  • Clarify the duplicate private DNS error tip by mentioning the existing endpoint is in the same VPC.

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

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

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

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

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 6, 2026

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 6, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 6, 2026

[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 oreoxmt 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 6, 2026
@qiancai qiancai added area/tidb-cloud This PR relates to the area of TiDB Cloud. cherry-pick-release-cloud/no-need No need to cherry pick this PR to the "release-cloud" branch. labels May 6, 2026
@qiancai qiancai force-pushed the fix-serverless-private-endpoint-vpc-scope branch from 7cccbc7 to b62e8c8 Compare May 6, 2026 06:12
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the documentation for setting up private endpoint connections for TiDB Cloud Serverless, specifically clarifying that private endpoints are scoped to a VPC and cannot be shared across VPCs. The review feedback focuses on improving clarity and readability by recommending the use of active voice and the second person, as well as removing redundant phrasing to better align with the style guide.

> **Note:**
>
> You only need to create one private endpoint per AWS region, which can be shared by all {{{ .starter }}} or {{{ .essential }}} instances located in the same region.
> For each VPC in an AWS Region, you only need to create one private endpoint. The endpoint can be used by all {{{ .starter }}} or {{{ .essential }}} instances in that Region from the same VPC, but cannot be shared across VPCs.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

low

To improve clarity and readability, avoid passive voice and redundant phrasing. The phrase 'which can be used by' is passive, and 'in the same Region' is repeated unnecessarily in the same sentence.

Suggested change
> For each VPC in an AWS Region, you only need to create one private endpoint. The endpoint can be used by all {{{ .starter }}} or {{{ .essential }}} instances in that Region from the same VPC, but cannot be shared across VPCs.
> {{{ .starter }}} or {{{ .essential }}} instances in the same AWS Region use the same TiDB Cloud PrivateLink endpoint service. In your AWS account, each private endpoint is scoped to a specific VPC. For each VPC in that Region, you only need to create one private endpoint. All {{{ .starter }}} or {{{ .essential }}} instances in that Region can then use this endpoint from the same VPC. You cannot share a private endpoint across VPCs.
References
  1. Avoid passive voice overuse. (link)
  2. Avoid unnecessary words and repetition. (link)

Comment thread tidb-cloud/set-up-private-endpoint-connections-serverless.md Outdated
Comment thread tidb-cloud/set-up-private-endpoint-connections-serverless.md Outdated
qiancai and others added 2 commits May 6, 2026 14:15
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@qiancai qiancai marked this pull request as ready for review May 6, 2026 06:17
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 6, 2026
@qiancai qiancai removed the missing-translation-status This PR does not have translation status info. label May 6, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 6, 2026

@sunxiaoguang: 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/tidb-cloud This PR relates to the area of TiDB Cloud. cherry-pick-release-cloud/no-need No need to cherry pick this PR to the "release-cloud" branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants