You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tidb-cloud/set-up-sink-private-endpoint.md
+31-24Lines changed: 31 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,60 +53,67 @@ If the Private Endpoint Service is not available for your downstream service, fo
53
53
</div>
54
54
</SimpleTab>
55
55
56
-
## Step 1. Open the private endpoint creation page
56
+
## Step 1. Open the Networking page for your cluster
57
57
58
58
1. Log in to the [TiDB Cloud console](https://tidbcloud.com/).
59
-
2. Navigate to the overview page of your TiDB Cloud Dedicated cluster, and then click **Settings** > **Networking** in the left navigation pane.
60
-
3. In the **Private Endpoint for Changefeed** section, click **Create Private Endpoint**.
59
+
2. On the [**Clusters**](https://tidbcloud.com/project/clusters) page, click the name of your target cluster to go to its overview page.
61
60
62
-
## Step 2. Configure the private endpoint for changefeed
61
+
> **Tip:**
62
+
>
63
+
> You can use the combo box in the upper-left corner to switch between organizations, projects, and clusters.
64
+
65
+
3. In the left navigation pane, click **Settings** > **Networking**.
66
+
67
+
## Step 2. Configure the private endpoint for changefeeds
63
68
64
69
The configuration steps vary depending on the cloud provider where your cluster is deployed.
65
70
66
71
<SimpleTab>
67
72
<divlabel="AWS">
68
73
69
-
1. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint.
70
-
2. Follow the reminder to authorize the [AWS Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-accounts) of TiDB Cloud to create an endpoint.
71
-
3. Enter the **Endpoint Service Name** that that you collected in the [Network](#network) section.
72
-
4. Select the **Number of AZs**. Ensure that the number of AZs and the AZ IDs match your Kafka deployment.
73
-
5. If this private endpoint is created for Apache Kafka, enable the **Advertised Listener for Kafka** option.
74
-
6. Configure the advertised listener for Kafka using either **TiDB Managed** domain or **Custom** domain.
74
+
1. On the **Networking** page, click **Create Private Endpoint** in the **AWS Private Endpoint for Changefeed** section.
75
+
2. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint.
76
+
3. Follow the reminder to authorize the [AWS Principal](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-accounts) of TiDB Cloud to create an endpoint.
77
+
4. Enter the **Endpoint Service Name** that that you collected in the [Network](#network) section.
78
+
5. Select the **Number of AZs**. Ensure that the number of AZs and the AZ IDs match your Kafka deployment.
79
+
6. If this private endpoint is created for Apache Kafka, enable the **Advertised Listener for Kafka** option.
80
+
7. Configure the advertised listener for Kafka using either **TiDB Managed** domain or **Custom** domain.
75
81
76
82
- To use **TiDB Managed** domain for advertised listeners, enter a unique string in the **Domain Pattern** field, and then click **Generate**. TiDB will generate broker addresses with subdomains for each availability zone.
77
83
- To use your own **Custom** domain for advertised listeners, switch the domain type to **Custom**, enter the root domain in the **Custom Domain** field, click **Check**, and then specify the broker subdomains for each availability zone.
78
84
79
-
7. Click **Create** to validate the configurations and create the private endpoint.
85
+
8. Click **Create** to validate the configurations and create the private endpoint.
80
86
81
87
</div>
82
88
83
89
<divlabel="Google Cloud">
84
90
85
-
1. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint.
86
-
2. Follow the reminder to authorize the [Google Cloud project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) of TiDB Cloud to pre-approve endpoint creation, or manually approve the endpoint connection request when you receive it.
87
-
3. Enter the **Service Attachment** that that you collected in the [Network](#network) section.
88
-
4. If this private endpoint is created for Apache Kafka, enable the **Advertised Listener for Kafka** option.
89
-
5. Configure the advertised listener for Kafka using either **TiDB Managed** domain or **Custom** domain.
91
+
1. On the **Networking** page, click **Create Private Endpoint** in the **Google Cloud Private Endpoint for Changefeed** section.
92
+
2. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint.
93
+
3. Follow the reminder to authorize the [Google Cloud project](https://cloud.google.com/resource-manager/docs/creating-managing-projects) of TiDB Cloud to pre-approve endpoint creation, or manually approve the endpoint connection request when you receive it.
94
+
4. Enter the **Service Attachment** that that you collected in the [Network](#network) section.
95
+
5. If this private endpoint is created for Apache Kafka, enable the **Advertised Listener for Kafka** option.
96
+
6. Configure the advertised listener for Kafka using either **TiDB Managed** domain or **Custom** domain.
90
97
91
98
- To use **TiDB Managed** domain for advertised listeners, enter a unique string in the **Domain Pattern** field, and then click **Generate**. TiDB will generate broker addresses with subdomains for each availability zone.
92
99
- To use your own **Custom** domain for advertised listeners, switch the domain type to **Custom**, enter the root domain in the **Custom Domain** field, click **Check**, and then specify the broker subdomains for each availability zone.
93
100
94
-
6. Click **Create** to validate the configurations and create the private endpoint.
101
+
7. Click **Create** to validate the configurations and create the private endpoint.
95
102
96
103
</div>
97
104
98
105
<divlabel="Azure">
99
106
100
-
1. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint.
101
-
2. Follow the reminder to authorize the Azure subscription of TiDB Cloud or allow anyone with your alias to access your Private Link service before creating the changefeed. For more information about Private Link service visibility, see [Control service exposure](https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#control-service-exposure) in Azure documentation.
102
-
3. Enter the **Alias of Private Link Service** that you collected in the [Network](#network) section.
103
-
4. If this private endpoint is created for Apache Kafka, enable the **Advertised Listener for Kafka** option.
104
-
5. Configure the advertised listener for Kafka using either **TiDB Managed** domain or **Custom** domain.
107
+
1. On the **Networking** page, click **Create Private Endpoint** in the **Azure Private Endpoint for Changefeed** section.
108
+
2. In the **Create Private Endpoint for Changefeed** dialog, enter a name for the private endpoint.
109
+
3. Follow the reminder to authorize the Azure subscription of TiDB Cloud or allow anyone with your alias to access your Private Link service before creating the changefeed. For more information about Private Link service visibility, see [Control service exposure](https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview#control-service-exposure) in Azure documentation.
110
+
4. Enter the **Alias of Private Link Service** that you collected in the [Network](#network) section.
111
+
5. If this private endpoint is created for Apache Kafka, enable the **Advertised Listener for Kafka** option.
112
+
6. Configure the advertised listener for Kafka using either **TiDB Managed** domain or **Custom** domain.
105
113
106
114
- To use **TiDB Managed** domain for advertised listeners, enter a unique string in the **Domain Pattern** field, and then click **Generate**. TiDB will generate broker addresses with subdomains for each availability zone.
107
115
- To use your own **Custom** domain for advertised listeners, switch the domain type to **Custom**, enter the root domain in the **Custom Domain** field, click **Check**, and then specify the broker subdomains for each availability zone.
108
-
109
-
6. Click **Create** to validate the configurations and create the private endpoint.
116
+
7. Click **Create** to validate the configurations and create the private endpoint.
0 commit comments