Skip to content

Commit 44d9c62

Browse files
authored
Rename VPC connection to PrivateLink (#2069)
* Update vpc-diagram.png * Update vpc-diagram.png * update * Update PrivateLink-diagram.png * update * Update PrivateLink-create-a-connection.md
1 parent 614baf2 commit 44d9c62

11 files changed

+153
-172
lines changed
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
id: PrivateLink-create-a-connection
3+
title: Create a PrivateLink connection
4+
description: Create a PrivateLink connection.
5+
slug: /create-a-connection
6+
---
7+
8+
Follow the steps below to create a PrivateLink connection between RisingWave Cloud and your VPC.
9+
10+
## Prerequisites
11+
12+
- You need to create a cluster with the Pro plan or Enterprise plan in RisingWave Cloud:
13+
14+
- See [Choose a cluster plan](/cluster-choose-a-cluster-plan.md) for more information. Please note that Developer clusters do not support PrivateLink connections.
15+
16+
- The VPC you want to connect to and your cluster must be in the same region. If your preferred region is not available when creating a cluster, contact our [support team](mailto:cloud-support@risingwave-labs.com) or [sales team](mailto:sales@risingwave-labs.com).
17+
18+
- You need to set up a PrivateLink service in your VPC and make sure it runs properly. The following links might be helpful:
19+
20+
- For AWS, see [Share your services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html).
21+
- For GCP, see [GCP Published services](https://cloud.google.com/vpc/docs/about-vpc-hosted-services).
22+
- For Azure, see [Azure Private Link services](https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview).
23+
24+
:::note
25+
Azure Private Link integration is currently in development and will be available soon.
26+
:::
27+
28+
## Steps
29+
30+
1. Go to the [**PrivateLink**](https://cloud.risingwave.com/connection/) page and click **Create PrivateLink**.
31+
32+
2. For **Platform**, select your cloud service provider. Currently, RisingWave Cloud supports **AWS** PrivateLink and **GCP** Private Service Connect.
33+
34+
3. For **Cluster**, select the cluster you want to connect the VPC to. Ensure that the VPC and the cluster are in the same region.
35+
36+
4. For **Name name**, enter a descriptive name for the connection.
37+
38+
5. For **Endpoint service name** or **Service attachment**:
39+
40+
<details><summary>If you choose AWS as the platform, enter the service name of the endpoint service.</summary>
41+
42+
You can find it in the [Amazon VPC console](https://console.aws.amazon.com/vpc/)**Endpoint services****Service name** section.
43+
44+
<img
45+
src={require('./images/aws-endpoint-service-name.png').default}
46+
alt="AWS endpoint service name"
47+
/>
48+
49+
</details>
50+
51+
<details><summary>If you choose GCP as the platform, enter the server target URL of the service attachment.</summary>
52+
53+
You can find it in the [Google Cloud Console](https://console.cloud.google.com/)**Network services****Private Service Connect**.
54+
55+
<img
56+
src={require('./images/gcp-service-attachment.png').default}
57+
alt="GCP Service attachment"
58+
/>
59+
60+
</details>
61+
62+
6. Click **Confirm** to create the connection.
63+
64+
## What's next
65+
66+
Now, you can create a source or sink with the PrivateLink connection using SQL.
67+
68+
For details on how to use the VPC endpoint to create a source with the PrivateLink connection, see [Create source with PrivateLink connection](/docs/current/ingest-from-kafka/#create-source-with-privatelink-connection); for creating a sink, see [Create sink with PrivateLink connection](/docs/current/create-sink-kafka/#create-sink-with-privatelink-connection).
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
id: PrivateLink-drop-a-connection
3+
title: Drop a PrivateLink connection
4+
description: If you no longer need to connect to a PrivateLink, you can drop the connection.
5+
slug: /drop-a-connection
6+
---
7+
8+
Follow the steps below to drop a connection to your VPC when you no longer need it.
9+
10+
1. Go to the [**Connection**](https://cloud.risingwave.com/connection/) page and click **Create PrivateLink**.
11+
12+
2. Hover over the connection you want to drop and click the delete button, then confirm the deletion.

cloud/PrivateLink-overview.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
id: PrivateLink-overview
3+
title: PrivateLink connection
4+
description: Manage PrivateLink connections.
5+
slug: /PrivateLink-overview
6+
---
7+
8+
## Concept
9+
10+
In RisingWave Cloud, if you want to connect RisingWave clusters with your services inside your private Virtual Private Cloud (VPC) network, you can use the PrivateLink service to establish a private and secure connection between RisingWave Cloud and your private VPC in the same region.
11+
12+
RisingWave Cloud utilizes the the private connection capability of the underlying Cloud vendors to establish the PrivateLink connection. In particular, the PrivateLink service is built on top of the following services:
13+
14+
- [AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html)
15+
- [GCP Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect)
16+
- [Azure Private Link](https://learn.microsoft.com/en-us/azure/private-link/)
17+
18+
:::note
19+
Azure Private Link integration is currently in development and will be available soon.
20+
:::
21+
22+
The diagram below depicts a high-level overview of how PrivateLink service works. Both all three platforms share the same pattern of network structure so that you can configure them in the same way automatically.
23+
24+
<img
25+
src={require('./images/PrivateLink-diagram.png').default}
26+
alt="VPC connection diagram"
27+
/>
28+
29+
On the **RisingWave Cloud** side, RisingWave Cloud will create an endpoint (specifically an AWS VPC endpoint, GCP Private Service Connect endpoint, or Azure private endpoint) and bind it with one running RisingWave cluster.
30+
31+
On the **Customer** side, you need to set up a PrivateLink service (specifically an AWS endpoint service, GCP published service, or Azure Private Link service) in your VPC network first.
32+
33+
<grid
34+
container
35+
direction="row"
36+
spacing="15"
37+
justifyContent="space-between"
38+
justifyItems="stretch"
39+
alignItems="stretch">
40+
41+
<grid item xs={12} sm={6} md={6}>
42+
43+
<card
44+
title="Create a connection"
45+
content="Create a PrivateLink connection between RisingWave Cloud and your VPC."
46+
cloud="create-a-connection"
47+
style={{height: "80%"}}
48+
/>
49+
50+
</grid>
51+
52+
<grid item xs={12} sm={6} md={6}>
53+
54+
<card
55+
title="Drop a connection"
56+
content="If you no longer need to connect to a VPC, you can drop the connection."
57+
cloud="drop-a-connection"
58+
style={{height: "80%"}}
59+
/>
60+
61+
</grid>
62+
63+
</grid>

cloud/images/PrivateLink-diagram.png

150 KB
Loading

cloud/images/vpc-diagram.png

-84.5 KB
Binary file not shown.

cloud/vpc-create-a-connection.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

cloud/vpc-drop-a-connection.md

Lines changed: 0 additions & 18 deletions
This file was deleted.

cloud/vpc-overview.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

docs/guides/create-sink-kafka.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -214,11 +214,11 @@ FORMAT PLAIN ENCODE JSON;
214214

215215
```
216216

217-
## Create sink with VPC connection
217+
## Create sink with PrivateLink connection
218218

219219
If your Kafka sink service is located in a different VPC from RisingWave, use AWS PrivateLink or GCP Private Service Connect to establish a secure and direct connection. For details on how to set up an AWS PrivateLink connection, see [Create an AWS PrivateLink connection](/sql/commands/sql-create-connection.md#create-an-aws-privatelink-connection).
220220

221-
To create a Kafka sink with a VPC connection, in the WITH section of your `CREATE SINK` statement, specify the following parameters.
221+
To create a Kafka sink with a PrivateLink connection, in the WITH section of your `CREATE SINK` statement, specify the following parameters.
222222

223223
|Parameter| Notes|
224224
|---|---|

docs/ingest/ingest-from-kafka.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -328,16 +328,16 @@ Based on the compatibility type that is configured for the schema registry, some
328328

329329
To learn about compatibility types for Schema Registry and the changes allowed, see [Compatibility Types](https://docs.confluent.io/platform/current/schema-registry/avro.html#compatibility-types).
330330

331-
## Create source with VPC connection
331+
## Create source with PrivateLink connection
332332

333333
If your Kafka source service is located in a different VPC from RisingWave, use AWS PrivateLink to establish a secure and direct connection. For details on how to set up an AWS PrivateLink connection, see [Create an AWS PrivateLink connection](/sql/commands/sql-create-connection.md#create-an-aws-privatelink-connection).
334334

335-
To create a Kafka source with a VPC connection, in the WITH section of your `CREATE SOURCE` or `CREATE TABLE` statement, specify the following parameters.
335+
To create a Kafka source with a PrivateLink connection, in the WITH section of your `CREATE SOURCE` or `CREATE TABLE` statement, specify the following parameters.
336336

337337
|Parameter| Notes|
338338
|---|---|
339339
|`privatelink.targets`| The PrivateLink targets that correspond to the Kafka brokers. The targets should be in JSON format. Note that each target listed corresponds to each broker specified in the `properties.bootstrap.server` field. If the order is incorrect, there will be connectivity issues. |
340-
|`privatelink.endpoint`|The DNS name of the VPC endpoint. <br/> If you're using RisingWave Cloud, you can find the auto-generated endpoint after you created a connection. See details in [Create a VPC connection](/cloud/create-a-connection#whats-next).|
340+
|`privatelink.endpoint`|The DNS name of the VPC endpoint. <br/> If you're using RisingWave Cloud, you can find the auto-generated endpoint after you created a connection. See details in [Create a PrivateLink connection](/cloud/create-a-connection#whats-next).|
341341
|`connection.name`| The name of the connection. <br/> This parameter should only be included if you are using a connection created with the [`CREATE CONNECTION`](/sql/commands/sql-create-connection.md) statement. Omit this parameter if you have provisioned a VPC endpoint using `privatelink.endpoint` (recommended).|
342342

343343
Here is an example of creating a Kafka source using a PrivateLink connection. Notice that `{"port": 9094}` corresponds to the broker `broker1-endpoint`, `{"port": 9095}` corresponds to the broker `broker2-endpoint`, and `{"port": 9096}` corresponds to the broker `broker3-endpoint`.

0 commit comments

Comments
 (0)