-
Notifications
You must be signed in to change notification settings - Fork 705
tidbcloud/premium: add create private endpoint #21923
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: release-8.5
Are you sure you want to change the base?
Conversation
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 Once the patch is verified, the new status will be reflected by the 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. |
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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.
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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
).
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
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. | ||
|
||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The formatting here is a bit confusing. Consider rephrasing this section to improve readability.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The phrase "of that row" is a bit informal. Consider rephrasing for better clarity.
- **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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence can be rephrased for better clarity and to correctly format the port number according to the style guide.
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. |
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
/ok-to-test |
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>
[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.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
@wildpcww: The following test failed, say
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. |
First-time contributors' checklist
What is changed, added or deleted? (Required)
Base on https://docs.pingcap.com/tidbcloud/set-up-private-endpoint-connections/
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?