cloud: clarify serverless private endpoint VPC scope#22849
cloud: clarify serverless private endpoint VPC scope#22849qiancai wants to merge 3 commits intopingcap:release-8.5from
Conversation
|
Skipping CI for Draft Pull Request. |
|
[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 |
7cccbc7 to
b62e8c8
Compare
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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.
| > 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. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
@sunxiaoguang: adding LGTM is restricted to approvers and reviewers in OWNERS files. DetailsIn 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. |
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:
Which TiDB version(s) do your changes apply to? (Required)
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?