Skip to content

Commit 94b06af

Browse files
committed
fix according to the preview
1 parent ba55775 commit 94b06af

5 files changed

+39
-34
lines changed

tidb-cloud/serverless-private-link-connection-to-alicloud-rds.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ This document describes how to connect to an Alibaba Cloud RDS instance using an
1111
- Manage load balancer
1212
- Manage endpoint services
1313

14-
3. Ensure your {{.essential}} in alibaba cloud provider and get its account ID and available zones, save the information for later use.
14+
3. Ensure your {{{ .essential }}} in alibaba cloud provider and get its account ID and available zones, save the information for later use.
1515

1616
1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane.
1717
2. On the **Private Link Connection For Dataflow**, click **Create Private Link Connection**.
18-
3. You can find the AWS account ID and available zones information.
18+
3. You can find the Alibaba Cloud account ID and available zones information.
1919

2020
## Step 1. Set up an RDS instance
2121

2222
Identify an Alibaba Cloud ApsaraDB RDS you want to use, or [set up a new RDS](https://www.alibabacloud.com/help/en/rds/apsaradb-rds-for-mysql/step-1-create-an-apsaradb-rds-for-mysql-instance-and-configure-databases).
2323

2424
The RDS must meet the following requirements:
2525

26-
- The Alibaba Cloud region for your RDS instance must be the same as the region for your {{.essential}}.
27-
- The subnet group of your RDS must have overlapping availability zones as your {{.essential}}.
26+
- The Alibaba Cloud region for your RDS instance must be the same as the region for your {{{ .essential }}}.
27+
- The subnet group of your RDS must have overlapping availability zones as your {{{ .essential }}}.
2828
- Make sure your RDS instance set proper IP whitelist and is accessible within the VPC.
2929

3030
> **Note**
@@ -49,7 +49,7 @@ Set up the load balancer in the same region of your RDS:
4949

5050
- **Network Type**: `Internal-facing`
5151
- **VPC**: The VPC where your RDS is located
52-
- **Zone**: Must have overlapping availability zones with your {{.essential}}
52+
- **Zone**: Must have overlapping availability zones with your {{{ .essential }}}
5353
- **IP Version**: `IPv4`
5454

5555
Find the load balancer you created, and then click **Create Listerner**:

tidb-cloud/serverless-private-link-connection-to-aws-confluent.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This document describes how to connect to an AWS Confluent Dedicated Cluster usi
1010

1111
1. You have a Confluent Cloud account.
1212

13-
2. Get the {{.essential}} account ID and available zones, save the information for later use.
13+
2. Ensure your {{{ .essential }}} in aws provider and get the {{{ .essential }}} account ID and available zones, save the information for later use.
1414

1515
1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane.
1616
2. On the **Private Link Connection For Dataflow**, click **Create Private Link Connection**.
@@ -22,16 +22,16 @@ Identify a Confluent Cloud network you want to use, or [set up a new Confluent C
2222

2323
The Confluent Cloud network must meet the following requirements:
2424

25-
- The network must be in the same AWS region as your {{.essential}}.
26-
- The network must have overlapping availability zones as your {{.essential}}, recommended to have same availability zones.
25+
- The network must be in the same AWS region as your {{{ .essential }}}.
26+
- The network must have overlapping availability zones as your {{{ .essential }}}, recommended to have same availability zones.
2727

2828
On the `Network overview` page, obtain the `DNS subdomain` of the Confluent Cloud network. You need to extract the unique name from it.
2929
For example, if the `DNS subdomain` is `use1-az1.domnprzqrog.us-east-1.aws.confluent.cloud`, then the unique name is `domnprzqrog.us-east-1`.
3030
Please save the unique name for later use.
3131

3232
> **Note**
3333
>
34-
> The Confluent Cloud Dedicated cluster you want TiDB Cloud to connect to must be under this network.
34+
> The Confluent Cloud Dedicated cluster you want TiDB Cloud to connect to must under this network.
3535
3636
## Step 2. Add a PrivateLink Access to the network
3737

@@ -80,7 +80,7 @@ ticloud serverless private-link-connection create -c <cluster-id> --display-name
8080
</div>
8181
</SimpleTab>
8282

83-
### Attach domains to the private link connection
83+
### 2. Attach domains to the private link connection
8484

8585
You will need the unique name you obtained in Step 1.
8686

tidb-cloud/serverless-private-link-connection-to-aws-rds.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This document describes how to connect to an AWS RDS instance using an AWS Endpo
1212
- Manage load balancer
1313
- Manage endpoint services
1414

15-
3. Get the {{.essential}} account ID and available zones, save the information for later use.
15+
3. Ensure your {{{ .essential }}} in aws provider and get the {{{ .essential }}} account ID and available zones, save the information for later use.
1616

1717
1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane.
1818
2. On the **Private Link Connection For Dataflow**, Click **Create Private Link Connection**.
@@ -24,8 +24,8 @@ Identify an AWS RDS instance to use, or [set up a new one](https://docs.aws.amaz
2424

2525
The RDS must meet the following requirements:
2626

27-
- The RDS must be in the same AWS region as your {{.essential}}.
28-
- The subnet group of your RDS must have overlapping availability zones as your {{.essential}}.
27+
- The RDS must be in the same AWS region as your {{{ .essential }}}.
28+
- The subnet group of your RDS must have overlapping availability zones as your {{{ .essential }}}.
2929
- Make sure your RDS instance set proper security group and is accessible within the VPC.
3030

3131
> **Note**
@@ -53,7 +53,7 @@ Set up the load balancer in the same region of your RDS:
5353
- **Schema**: `Internal`
5454
- **Load balancer IP address type**: `IPv4`
5555
- **VPC**: The VPC where your RDS is located
56-
- **Availability Zones**: Must have overlapping availability zones with your {{.essential}}
56+
- **Availability Zones**: Must have overlapping availability zones with your {{{ .essential }}}
5757
- **Security groups**: Create a new security group with the following rules.
5858
- Inbound rule allows MySQL/Aurora: Type - `MySQL/Aurora`; Source - `Anywhere-IPv4`.
5959
- Outbound rule allows all TCP: Type - `All TCP`; Destination - `Anywhere-IPv4`

tidb-cloud/serverless-private-link-connection-to-self-hosted-kafka-in-aws.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The mechanism works as follows:
2323
- Manage load balancer
2424
- Manage endpoint services
2525

26-
3. Get the {{.essential}} account ID and available zones, save the information for later use.
26+
3. Ensure your {{{ .essential }}} in aws provider and get the {{{ .essential }}} account ID and available zones, save the information for later use.
2727

2828
1. In the [TiDB Cloud console](https://tidbcloud.com), navigate to the cluster overview page of the TiDB cluster, and then click **Settings** > **Networking** in the left navigation pane.
2929
2. On the **Private Link Connection For Dataflow**, click **Create Private Link Connection**.
@@ -744,7 +744,7 @@ ticloud serverless private-link-connection create -c <cluster-id> --display-name
744744
</div>
745745
</SimpleTab>
746746
747-
### Attach Domains to the Private Link Connection
747+
### 2. Attach Domains to the Private Link Connection
748748
749749
You can also refer to [Attach Domains to a Private Link Connection](/tidbcloud/serverless-private-link-connection#attach-domains-to-a-private-link-connection) for more details.
750750
@@ -763,7 +763,7 @@ You can also refer to [Attach Domains to a Private Link Connection](/tidbcloud/s
763763
764764
4. Click **Attach Domains**.
765765
766-
5. In the **Attach Domains** dialog, select the **TiDB Cloud Managed** domain type. The domains will be auto-generated by TiDB Cloud. Copy the unique name for later use and click **Attach Domains** to confirm.
766+
5. In the **Attach Domains** dialog, select the **TiDB Cloud Managed** domain type. The domains will be auto-generated by TiDB Cloud. Copy the unique name for later use and click **Attach Domains** to confirm. For example, if the generated domain is `*.use1-az1.dvs6nl5jgveztmla3pxkxgh76i.aws.plc.tidbcloud.com`, then the unique name is `dvs6nl5jgveztmla3pxkxgh76i`.
767767
768768
</div>
769769
@@ -786,5 +786,5 @@ ticloud serverless private-link-connection attach-domains -c <cluster-id> --priv
786786
787787
## Step 4. Replace the Unique Name placeholder in Kafka configuration
788788
789-
1. Go back to your Kafka broker nodes, and replace the `unique_name` placeholder of each broker with the actual unique name you get from the previous step.
789+
1. Go back to your Kafka broker nodes, replace the `unique_name` placeholder in `advertised.listeners` configuration of each broker with the actual unique name you get from the previous step.
790790
2. After you reconfigure all the brokers, restart your Kafka brokers one by one.

tidb-cloud/serverless-private-link-connection.md

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -12,19 +12,19 @@ The Private Link Connection enables private, direct connectivity between {{{ .es
1212

1313
This type of private link connection enables TiDB Cloud clusters on **AWS** to connect to your [AWS endpoint service](https://docs.aws.amazon.com/vpc/latest/privatelink/create-endpoint-service.html) powered by AWS PrivateLink.
1414

15-
The Private Link Connection can access various AWS services by attach them to the endpoint service, including RDS instances and Kafka services, over a private network.
15+
The Private Link Connection can access various AWS services by associating them to the endpoint service, such as RDS instances and Kafka services.
1616

1717
### AliCloud Endpoint Service
1818

19-
This type of private link connection enables TiDB Cloud clusters on **Alibaba Cloud** to connect to your [Alibaba Cloud endpoint service](https://www.alibabacloud.com/help/en/privatelink/share-your-service/) powered by Alibaba Cloud PrivateLink.
19+
This type of private link connection enables TiDB Cloud clusters on **Alibaba Cloud** to connect to your [Alibaba Cloud endpoint service](https://www.alibabacloud.com/help/en/privatelink/share-your-service/#51976edba8no7) powered by Alibaba Cloud PrivateLink.
2020

21-
The Private Link Connection can access various Alibaba Cloud services by attaching them to the endpoint service, including RDS instances and Kafka services, over a private network.
21+
The Private Link Connection can access various Alibaba Cloud services by associating them to the endpoint service, such as RDS instances and Kafka services.
2222

2323
## Attach Domains
2424

2525
You can attach domains to a private link connection.
2626

27-
When a domain is attached to the Private Link Connection, all traffic to this domain will be routed to this private link connection. It is useful when your service provides custom domains to clients at runtime, such as Kafka advertised listeners.
27+
When a domain is attached to the private link connection, all traffic to this domain will be routed to this private link connection. It is useful when your service provides custom domains to clients at runtime, such as Kafka advertised listeners.
2828

2929
Different Private Link Connection types support attaching different domains:
3030

@@ -61,11 +61,13 @@ You can manage Private Link Connections in the Console or via CLI.
6161
- **Endpoint Service Name**: Enter your AWS endpoint service name (for example, `com.amazonaws.vpce.<region>.vpce-svc-xxxx`).
6262

6363
> **Note:**
64-
> **Note:**
64+
>
6565
> Please make sure the AWS endpoint service:
66-
> 1. Is in the same region as the TiDB Cloud cluster.
66+
>
67+
> 1. In the same region as your TiDB Cloud cluster.
6768
> 2. Allows connections from the TiDB Cloud account.
68-
> 3. Has availability zones that overlap with the TiDB Cloud cluster.
69+
> 3. Has availability zones that overlap with your TiDB Cloud cluster.
70+
>
6971
> You can get the account ID and available zones information at the bottom of the dialog.
7072
7173
5. Click the **Create Connection** button.
@@ -80,8 +82,9 @@ ticloud serverless private-link-connection create -c <cluster-id> --display-name
8082

8183
Please make sure the AWS endpoint service:
8284

83-
1. Allows the acceptance of TiDB Cloud account.
84-
2. Has overlapping available zones of TiDB Cloud cluster.
85+
1. In the same region of your TiDB Cloud cluster.
86+
2. Allows the acceptance of TiDB Cloud account.
87+
3. Has overlapping available zones of your TiDB Cloud cluster.
8588

8689
You can get the account ID and available zones information by the following command:
8790

@@ -110,16 +113,18 @@ ticloud serverless private-link-connection zones --cluster-id <cluster-id>
110113
4. Enter the required information in the **Create Private Link Connection** dialog:
111114

112115
- **Private Link Connection Name**: Enter a name for the Private Link Connection.
113-
- **Connection Type**: Choose **AliCloud Endpoint Service**, if you can not find this option, please ensure that your cluster is created in Alibaba Cloud provider.
116+
- **Connection Type**: Choose **AliCloud Endpoint Service**. If you can not find this option, please ensure that your cluster is created in Alibaba Cloud provider.
114117
- **Endpoint Service Name**: Enter your Alibaba Cloud endpoint service name (for example, `com.aliyuncs.privatelink.<region>.xxxxx`).
115118

116119
> **Note:**
120+
>
117121
> Please make sure the Alibaba Cloud endpoint service:
118-
> 1. Is in the same region as the TiDB Cloud cluster.
122+
>
123+
> 1. In the same region as your TiDB Cloud cluster.
119124
> 2. Allows connections from the TiDB Cloud account.
120-
> 3. Has availability zones that overlap with the TiDB Cloud cluster.
125+
> 3. Has availability zones that overlap with your TiDB Cloud cluster.
126+
>
121127
> You can get the account ID and available zones information at the bottom of the dialog.
122-
> You can get the account ID and available zones information in the button of the dialog.
123128
124129
5. Click the **Create Connection** button.
125130

@@ -133,9 +138,9 @@ ticloud serverless private-link-connection create -c <cluster-id> --display-name
133138

134139
Please make sure the Alibaba Cloud endpoint service:
135140

136-
1. In the same region of the TiDB Cloud cluster.
141+
1. In the same region of your TiDB Cloud cluster.
137142
2. Allows the acceptance of TiDB Cloud account.
138-
3. Has overlapping available zones of TiDB Cloud cluster.
143+
3. Has overlapping available zones of your TiDB Cloud cluster.
139144

140145
You can get the account ID and available zones information by the following command:
141146

@@ -222,7 +227,7 @@ ticloud serverless private-link-connection attach-domains -c <cluster-id> --priv
222227
</div>
223228
</SimpleTab>
224229

225-
## Detach Domains from a Private Link Connection
230+
### Detach Domains from a Private Link Connection
226231

227232
<SimpleTab>
228233
<div label="Console">

0 commit comments

Comments
 (0)