Skip to content

Conversation

wildpcww
Copy link
Collaborator

First-time contributors' checklist

What is changed, added or deleted? (Required)

Base on https://docs.pingcap.com/tidbcloud/set-up-private-endpoint-connections/

  1. changed Dedicated cluster-> Premium instance
  2. deleted project-level description

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)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)

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

  • This PR is translated from:
  • Other reference 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 ti-chi-bot bot added contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. labels Oct 16, 2025
Copy link

ti-chi-bot bot commented Oct 16, 2025

Hi @wildpcww. Thanks for your PR.

I'm waiting for a pingcap member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@ti-chi-bot ti-chi-bot bot added the needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. label Oct 16, 2025
Copy link

Summary of Changes

Hello @wildpcww, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces new documentation that guides users through the process of establishing secure and private connections to TiDB Cloud Premium instances via AWS PrivateLink. The new guide provides detailed, step-by-step instructions, covering prerequisites, endpoint creation, DNS configuration, and troubleshooting, ensuring users can effectively manage their network access to TiDB Cloud.

Highlights

  • New Documentation: Added a comprehensive guide on how to connect to TiDB Cloud Premium instances using AWS PrivateLink, ensuring secure and private network access.
  • Terminology Update: Updated product terminology within the documentation, specifically changing 'Dedicated cluster' to 'Premium instance' for consistency.
  • Content Refinement: Removed project-level descriptions to streamline the documentation and improve clarity.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@ti-chi-bot ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Oct 16, 2025
Copy link

@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 adds a new documentation page for connecting to a TiDB Cloud Premium instance via AWS PrivateLink. The changes are well-structured and mostly align with the documentation style guide. I've provided several suggestions to improve clarity, fix minor grammatical issues and typos, correct broken internal links, and ensure consistency. These changes will help make the document more polished and easier for users to follow.

Comment on lines 43 to 47
1. [Select a TiDB instance](#step-1-select-a-tidb-cluster)
2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint)
3. [Create a private endpoint connection](#step-3-create-a-private-endpoint-connection)
4. [Enable private DNS](#step-4-enable-private-dns)
5. [Connect to your TiDB instance](#step-5-connect-to-your-tidb-cluster)

Choose a reason for hiding this comment

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

medium

The anchors in these links point to tidb-cluster, but the corresponding headings use "TiDB instance". This will result in broken links. Please update the anchors to match the headings (e.g., #step-1-select-a-tidb-instance).

Suggested change
1. [Select a TiDB instance](#step-1-select-a-tidb-cluster)
2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint)
3. [Create a private endpoint connection](#step-3-create-a-private-endpoint-connection)
4. [Enable private DNS](#step-4-enable-private-dns)
5. [Connect to your TiDB instance](#step-5-connect-to-your-tidb-cluster)
1. [Select a TiDB instance](#step-1-select-a-tidb-instance)
2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint)
3. [Create a private endpoint connection](#step-3-create-a-private-endpoint-connection)
4. [Enable private DNS](#step-4-enable-private-dns)
5. [Connect to your TiDB instance](#step-5-connect-to-your-tidb-instance)


### Step 1. Select a TiDB instance

1. On the [**Instances**](https://tidbcloud.com/tidbs?orgId=1372813089208281461&uiMode=new-offerings-preview) page of your TiDB Cloud web console, click the name of your target TiDB instance to go to its overview page.

Choose a reason for hiding this comment

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

medium

The URL for the Instances page contains a hardcoded organization ID and other query parameters, which is not suitable for public documentation. Please use a generic URL.

Suggested change
1. On the [**Instances**](https://tidbcloud.com/tidbs?orgId=1372813089208281461&uiMode=new-offerings-preview) page of your TiDB Cloud web console, click the name of your target TiDB instance to go to its overview page.
1. On the [**Instances**](https://tidbcloud.com/console/instances) page of your TiDB Cloud web console, click the name of your target TiDB instance to go to its overview page.

- The private endpoint and the TiDB instance to be connected must be located in the same region.



Choose a reason for hiding this comment

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

low

Please remove this extra blank line to improve formatting.

Comment on lines +179 to +180
When you use private endpoint connections, the statuses of private endpoints or private endpoint services is displayed on your instance-level **Networking** page:
- switch to your target instance using the combo box in the upper-left corner, and then click **Settings** > **Networking** in the left navigation pane.

Choose a reason for hiding this comment

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

low

The formatting here is a bit confusing. Consider rephrasing this section to improve readability.

Suggested change
When you use private endpoint connections, the statuses of private endpoints or private endpoint services is displayed on your instance-level **Networking** page:
- switch to your target instance using the combo box in the upper-left corner, and then click **Settings** > **Networking** in the left navigation pane.
When you use private endpoint connections, the statuses of private endpoints or private endpoint services are displayed on the **Networking** page for your instance. To view this page, switch to your target instance using the combo box in the upper-left corner, and then click **Settings** > **Networking** in the left navigation pane.

- **Pending**: Waiting for processing.
- **Active**: Your private endpoint is ready to use. You cannot edit the private endpoint of this status.
- **Deleting**: The private endpoint is being deleted.
- **Failed**: The private endpoint creation fails. You can click **Edit** of that row to retry the creation.

Choose a reason for hiding this comment

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

low

The phrase "of that row" is a bit informal. Consider rephrasing for better clarity.

Suggested change
- **Failed**: The private endpoint creation fails. You can click **Edit** of that row to retry the creation.
- **Failed**: The private endpoint creation fails. You can click **Edit** in that row to retry the creation.


### I cannot connect to a TiDB instance via a private endpoint after enabling private DNS. Why?

You might need to properly set the security group for your VPC endpoint in the AWS Management Console. Go to **VPC** > **Endpoints**. Right-click your VPC endpoint and select the proper **Manage security groups**. A proper security group within your VPC that allows inbound access from your EC2 instances on Port 4000 or a customer-defined port.

Choose a reason for hiding this comment

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

low

This sentence can be rephrased for better clarity and to correctly format the port number according to the style guide.

Suggested change
You might need to properly set the security group for your VPC endpoint in the AWS Management Console. Go to **VPC** > **Endpoints**. Right-click your VPC endpoint and select the proper **Manage security groups**. A proper security group within your VPC that allows inbound access from your EC2 instances on Port 4000 or a customer-defined port.
You might need to properly set the security group for your VPC endpoint in the AWS Management Console. To do so, go to **VPC** > **Endpoints**, right-click your VPC endpoint, and select **Manage security groups**. Ensure that the selected security group allows inbound access from your EC2 instances on port `4000` or a customer-defined port.

wildpcww and others added 2 commits October 16, 2025 14:43
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@lilin90 lilin90 added for-cloud-release This PR is related to TiDB Cloud release. translation/no-need No need to translate this PR. labels Oct 16, 2025
@ti-chi-bot ti-chi-bot bot removed the missing-translation-status This PR does not have translation status info. label Oct 16, 2025
@lilin90
Copy link
Member

lilin90 commented Oct 16, 2025

/ok-to-test

@ti-chi-bot ti-chi-bot bot added ok-to-test Indicates a PR is ready to be tested. and removed needs-ok-to-test Indicates a PR created by contributors and need ORG member send '/ok-to-test' to start testing. labels Oct 16, 2025
wildpcww and others added 4 commits October 16, 2025 17:56
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@lilin90 lilin90 self-assigned this Oct 20, 2025
Copy link

ti-chi-bot bot commented Oct 21, 2025

[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.

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

Copy link

ti-chi-bot bot commented Oct 21, 2025

@wildpcww: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
pull-verify 1edcb9a link true /test pull-verify

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

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

Labels

contribution This PR is from a community contributor. first-time-contributor Indicates that the PR was contributed by an external member and is a first-time contributor. for-cloud-release This PR is related to TiDB Cloud release. ok-to-test Indicates a PR is ready to be tested. size/L Denotes a PR that changes 100-499 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