Skip to content

Commit 8f394ff

Browse files
committed
new-doc
1 parent ed8b63c commit 8f394ff

File tree

2 files changed

+28
-36
lines changed

2 files changed

+28
-36
lines changed

tidb-cloud/set-up-private-endpoint-connections-on-google-cloud.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In most scenarios, it is recommended that you use private endpoint connection ov
4646
To connect to your TiDB Dedicated cluster via a private endpoint, complete the [prerequisites](#prerequisites) and follow these steps:
4747

4848
1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster)
49-
2. [Provide the information for creating an endpoint](#step-2-provide-the-information-for-creating-an-endpoint)
49+
2. [Create a Google Cloud endpoint](#step-2-create-a-google-cloud-endpoint)
5050
3. [Accept endpoint access](#step-3-accept-endpoint-access)
5151
4. [Connect to your TiDB cluster](#step-4-connect-to-your-tidb-cluster)
5252

@@ -75,11 +75,11 @@ Perform the following steps to go to the **Google Cloud Private Endpoint** page:
7575
1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
7676
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
7777
3. On the **Project Settings** page of your project, click **Network Access** in the left navigation pane, and click the **Private Endpoint** tab.
78-
4. Click **Create Private Endpoint** in the upper-right corner, and then select **Google Cloud Private Endpoint**.
78+
4. Click **Google Cloud** to view the Google Cloud private endpoints, and then select **Create Google Cloud Private Endpoint Connection**.
7979

8080
### Step 1. Choose a TiDB cluster
8181

82-
Click the drop-down list and choose an available TiDB Dedicated cluster.
82+
Select an TiDB Dedicated cluster from the drop-down list for which you wish to establish a private endpoint connection.
8383

8484
You can select a cluster with any of the following statuses:
8585

@@ -88,7 +88,7 @@ You can select a cluster with any of the following statuses:
8888
- **Modifying**
8989
- **Importing**
9090

91-
### Step 2. Provide the information for creating an endpoint
91+
### Step 2. Create a Google Cloud endpoint
9292

9393
1. Provide the following information to generate the command for private endpoint creation:
9494
- **Google Cloud Project ID**: the Project ID associated with your Google Cloud account. You can find the ID on the [Google Cloud **Dashboard** page](https://console.cloud.google.com/home/dashboard).
@@ -97,7 +97,7 @@ You can select a cluster with any of the following statuses:
9797
- **Private Service Connect Endpoint Name**: enter a unique name for the private endpoint that will be created.
9898
2. After entering the information, click **Generate Command**.
9999
3. Copy the command.
100-
4. Go to [Google Cloud Shell](https://console.cloud.google.com/home/dashboard) to execute the command.
100+
4. Go to [Google Cloud Shell](https://console.cloud.google.com/home/dashboard) to execute the command to create an endpoint.
101101

102102
### Step 3. Accept endpoint access
103103

tidb-cloud/set-up-private-endpoint-connections.md

Lines changed: 23 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,10 @@ In most scenarios, you are recommended to use private endpoint connection over V
4141
To connect to your TiDB Dedicated cluster via a private endpoint, complete the [prerequisites](#prerequisites) and follow these steps:
4242

4343
1. [Choose a TiDB cluster](#step-1-choose-a-tidb-cluster)
44-
2. [Check the service endpoint region](#step-2-check-the-service-endpoint-region)
45-
3. [Create an AWS interface endpoint](#step-3-create-an-aws-interface-endpoint)
46-
4. [Accept the endpoint connection](#step-4-accept-the-endpoint-connection)
47-
5. [Enable private DNS](#step-5-enable-private-dns)
48-
6. [Connect to your TiDB cluster](#step-6-connect-to-your-tidb-cluster)
44+
2. [Create an AWS interface endpoint](#step-2-create-an-aws-interface-endpoint)
45+
3. [Fill in your endpoint ID](#step-3-fill-in-your-endpoint-id)
46+
4. [Enable private DNS and create connection](#step-4-enable-private-dns-and-create-connection)
47+
5. [Connect to your TiDB cluster](#step-5-connect-to-your-tidb-cluster)
4948

5049
If you have multiple clusters, you need to repeat these steps for each cluster that you want to connect to using AWS PrivateLink.
5150

@@ -54,34 +53,28 @@ If you have multiple clusters, you need to repeat these steps for each cluster t
5453
1. Log in to the [TiDB Cloud console](https://tidbcloud.com).
5554
2. Click <MDSvgIcon name="icon-left-projects" /> in the lower-left corner, switch to the target project if you have multiple projects, and then click **Project Settings**.
5655
3. On the **Project Settings** page of your project, click **Network Access** in the left navigation pane, and click the **Private Endpoint** tab.
57-
4. Click **Create Private Endpoint** in the upper-right corner, and then select **AWS Private Endpoint**.
56+
4. Click **Create Private Endpoint Connection** in the upper-right corner.
5857

5958
### Step 1. Choose a TiDB cluster
6059

61-
1. Click the drop-down list and choose an available TiDB Dedicated cluster.
62-
2. Click **Next**.
60+
1. Select an available TiDB Dedicated cluster from the drop-down list for which you wish to establish a private endpoint connection.
6361

64-
### Step 2. Check the service endpoint region
65-
66-
Your service endpoint region is selected by default. Have a quick check and click **Next**.
67-
68-
> **Note:**
69-
>
70-
> The default region is where your cluster is located. Do not change it. Cross-region private endpoint is currently not supported.
71-
72-
### Step 3. Create an AWS interface endpoint
62+
### Step 2. Create an AWS interface endpoint
7363

7464
> **Note:**
7565
>
7666
> For each TiDB Dedicated cluster created after March 28, 2023, the corresponding endpoint service is automatically created 3 to 4 minutes after the cluster creation.
7767
78-
If you see the `Endpoint Service Ready` message, take note of your endpoint service name from the command in the lower area of the console for later use. Otherwise, wait 3 to 4 minutes to let TiDB Cloud create an endpoint service for your cluster.
68+
If you see the `TiDB Private Link Service is ready` message, the corresponding endpoint service is ready and you cancollect information needed for creating the endpoint.
69+
70+
1. Fill in the **VPC ID** and **Subnet IDs** fields on the private endpoint creation page. You can get the IDs from your AWS Management Console.
71+
2. Click **Generate Command** to get the following endpoint creation command.
7972

8073
```bash
8174
aws ec2 create-vpc-endpoint --vpc-id ${your_vpc_id} --region ${your_region} --service-name ${your_endpoint_service_name} --vpc-endpoint-type Interface --subnet-ids ${your_application_subnet_ids}
8275
```
8376

84-
Then create an AWS interface endpoint either using the AWS Management Console or using the AWS CLI.
77+
Then you can create an AWS interface endpoint either using the AWS Management Console or using the AWS CLI.
8578

8679
<SimpleTab>
8780
<div label="Use AWS Console">
@@ -96,7 +89,7 @@ To use the AWS Management Console to create a VPC interface endpoint, perform th
9689
![Verify endpoint service](/media/tidb-cloud/private-endpoint/create-endpoint-2.png)
9790

9891
3. Select **Other endpoint services**.
99-
4. Enter the service name that you found in the TiDB Cloud console.
92+
4. Enter the service name that you found in the generated command from "--service-name ${your_endpoint_service_name}" part.
10093
5. Click **Verify service**.
10194
6. Select your VPC in the drop-down list.
10295
7. Select the availability zones where your TiDB cluster is located in the **Subnets** area.
@@ -118,27 +111,26 @@ To use the AWS Management Console to create a VPC interface endpoint, perform th
118111

119112
To use the AWS CLI to create a VPC interface endpoint, perform the following steps:
120113

121-
1. Fill in the **VPC ID** and **Subnet IDs** fields on the private endpoint creation page. You can get the IDs from your AWS Management Console.
122-
2. Copy the command in the lower area of the page and run it in your terminal. Then click **Next**.
114+
1. Copy the generated command in the lower area of the page and run it in your terminal.
115+
2. Record the VPC endpoint ID you just created.
123116

124117
> **Tip:**
125118
>
126119
> - Before running the command, you need to have AWS CLI installed and configured. See [AWS CLI configuration basics](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html) for details.
127120
>
128121
> - If your service is spanning across more than three availability zones (AZs), you will get an error message indicating that the VPC endpoint service does not support the AZ of the subnet. This issue occurs when there is an extra AZ in your selected region in addition to the AZs where your TiDB cluster is located. In this case, you can contact [PingCAP Technical Support](https://docs.pingcap.com/tidbcloud/tidb-cloud-support).
129-
>
130-
> - You cannot copy the command until TiDB Cloud finishes creating an endpoint service in the background.
122+
131123

132124
</div>
133125
</SimpleTab>
134126

135-
### Step 4. Accept the endpoint connection
127+
### Step 3. Fill in your endpoint ID
136128

137129
1. Go back to the TiDB Cloud console.
138-
2. Fill in the box with your VPC endpoint ID on the **Create Private Endpoint** page.
139-
3. Click **Next**.
130+
2. Fill in the box with your VPC endpoint ID on the **Create AWS Private Endpoint Connection** page.
131+
140132

141-
### Step 5. Enable private DNS
133+
### Step 4. Enable private DNS and create connection
142134

143135
Enable private DNS in AWS. You can either use the AWS Management Console or the AWS CLI.
144136

@@ -166,11 +158,11 @@ aws ec2 modify-vpc-endpoint --vpc-endpoint-id ${your_vpc_endpoint_id} --private-
166158
</div>
167159
</SimpleTab>
168160

169-
Click **Create** in the TiDB Cloud console to finalize the creation of the private endpoint.
161+
Click **Create Private Endpoint Connection** in the TiDB Cloud console to finalize the creation of the private endpoint.
170162

171-
Then you can connect to the endpoint service.
163+
Then you can connect to your TiDB cluster.
172164

173-
### Step 6. Connect to your TiDB cluster
165+
### Step 5. Connect to your TiDB cluster
174166

175167
After you have enabled the private DNS, go back to the TiDB Cloud console and take the following steps:
176168

0 commit comments

Comments
 (0)