forked from phadkesharan/risingwave-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'risingwavelabs:main' into main
- Loading branch information
Showing
16 changed files
with
202 additions
and
180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
--- | ||
id: PrivateLink-create-a-connection | ||
title: Create a PrivateLink connection | ||
description: Create a PrivateLink connection. | ||
slug: /create-a-connection | ||
--- | ||
|
||
Follow the steps below to create a PrivateLink connection between RisingWave Cloud and your VPC. | ||
|
||
## Prerequisites | ||
|
||
- You need to create a cluster with the Pro plan or Enterprise plan in RisingWave Cloud: | ||
|
||
- See [Choose a cluster plan](/cluster-choose-a-cluster-plan.md) for more information. Please note that Developer clusters do not support PrivateLink connections. | ||
|
||
- 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:[email protected]) or [sales team](mailto:[email protected]). | ||
|
||
- You need to set up a PrivateLink service in your VPC and make sure it runs properly. The following links might be helpful: | ||
|
||
- For AWS, see [Share your services through AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/privatelink-share-your-services.html). | ||
- For GCP, see [GCP Published services](https://cloud.google.com/vpc/docs/about-vpc-hosted-services). | ||
- For Azure, see [Azure Private Link services](https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview). | ||
|
||
:::note | ||
Azure Private Link integration is currently in development and will be available soon. | ||
::: | ||
|
||
## Steps | ||
|
||
1. Go to the [**PrivateLink**](https://cloud.risingwave.com/connection/) page and click **Create PrivateLink**. | ||
|
||
2. For **Platform**, select your cloud service provider. Currently, RisingWave Cloud supports **AWS** PrivateLink and **GCP** Private Service Connect. | ||
|
||
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. | ||
|
||
4. For **Name name**, enter a descriptive name for the connection. | ||
|
||
5. For **Endpoint service name** or **Service attachment**: | ||
|
||
<details><summary>If you choose AWS as the platform, enter the service name of the endpoint service.</summary> | ||
|
||
You can find it in the [Amazon VPC console](https://console.aws.amazon.com/vpc/) → **Endpoint services** → **Service name** section. | ||
|
||
<img | ||
src={require('./images/aws-endpoint-service-name.png').default} | ||
alt="AWS endpoint service name" | ||
/> | ||
|
||
</details> | ||
|
||
<details><summary>If you choose GCP as the platform, enter the server target URL of the service attachment.</summary> | ||
|
||
You can find it in the [Google Cloud Console](https://console.cloud.google.com/) → **Network services** → **Private Service Connect**. | ||
|
||
<img | ||
src={require('./images/gcp-service-attachment.png').default} | ||
alt="GCP Service attachment" | ||
/> | ||
|
||
</details> | ||
|
||
6. Click **Confirm** to create the connection. | ||
|
||
## What's next | ||
|
||
Now, you can create a source or sink with the PrivateLink connection using SQL. | ||
|
||
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
id: PrivateLink-drop-a-connection | ||
title: Drop a PrivateLink connection | ||
description: If you no longer need to connect to a PrivateLink, you can drop the connection. | ||
slug: /drop-a-connection | ||
--- | ||
|
||
Follow the steps below to drop a connection to your VPC when you no longer need it. | ||
|
||
1. Go to the [**Connection**](https://cloud.risingwave.com/connection/) page and click **Create PrivateLink**. | ||
|
||
2. Hover over the connection you want to drop and click the delete button, then confirm the deletion. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
id: PrivateLink-overview | ||
title: PrivateLink connection | ||
description: Manage PrivateLink connections. | ||
slug: /PrivateLink-overview | ||
--- | ||
|
||
## Concept | ||
|
||
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. | ||
|
||
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: | ||
|
||
- [AWS PrivateLink](https://docs.aws.amazon.com/vpc/latest/privatelink/what-is-privatelink.html) | ||
- [GCP Private Service Connect](https://cloud.google.com/vpc/docs/private-service-connect) | ||
- [Azure Private Link](https://learn.microsoft.com/en-us/azure/private-link/) | ||
|
||
:::note | ||
Azure Private Link integration is currently in development and will be available soon. | ||
::: | ||
|
||
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. | ||
|
||
<img | ||
src={require('./images/PrivateLink-diagram.png').default} | ||
alt="VPC connection diagram" | ||
/> | ||
|
||
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. | ||
|
||
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. | ||
|
||
<grid | ||
container | ||
direction="row" | ||
spacing="15" | ||
justifyContent="space-between" | ||
justifyItems="stretch" | ||
alignItems="stretch"> | ||
|
||
<grid item xs={12} sm={6} md={6}> | ||
|
||
<card | ||
title="Create a connection" | ||
content="Create a PrivateLink connection between RisingWave Cloud and your VPC." | ||
cloud="create-a-connection" | ||
style={{height: "80%"}} | ||
/> | ||
|
||
</grid> | ||
|
||
<grid item xs={12} sm={6} md={6}> | ||
|
||
<card | ||
title="Drop a connection" | ||
content="If you no longer need to connect to a VPC, you can drop the connection." | ||
cloud="drop-a-connection" | ||
style={{height: "80%"}} | ||
/> | ||
|
||
</grid> | ||
|
||
</grid> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.