Skip to content

Commit 9e164c0

Browse files
authored
DOC-662 interrupted communication after private networking (#154)
* DOC-662 interrupted communication after private networking * update tips * incorporate feedback from Masa * move to section for enable on existing clusters * incorporate Masa's review feedback
1 parent f014761 commit 9e164c0

File tree

5 files changed

+10
-8
lines changed

5 files changed

+10
-8
lines changed

modules/networking/pages/aws-privatelink.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
include::shared:partial$feature-flag.adoc[]
77

8-
NOTE: This guide is for configuring AWS PrivateLink using the Redpanda Cloud API. See xref:networking:configure-privatelink-in-cloud-ui.adoc[Configure PrivateLink in the Cloud UI] if you want to set up the endpoint service using the UI.
8+
NOTE: This guide is for configuring AWS PrivateLink using the Redpanda Cloud API. To configure and manage PrivateLink on an existing public cluster, you must use the Cloud API. See xref:networking:configure-privatelink-in-cloud-ui.adoc[Configure PrivateLink in the Cloud UI] if you want to set up the endpoint service using the Redpanda Cloud UI.
99

1010
The Redpanda AWS PrivateLink endpoint service provides secure access to Redpanda Cloud from your own VPC. Traffic over PrivateLink does not go through the public internet because a PrivateLink connection is treated as its own private AWS service. While your VPC has access to the Redpanda VPC, Redpanda cannot access your VPC.
1111

@@ -19,8 +19,6 @@ Consider using the PrivateLink endpoint service if you have multiple VPCs and co
1919

2020
After <<get-a-cloud-api-access-token,getting an access token>>, you can <<create-new-cluster-with-privatelink-endpoint-service-enabled,enable PrivateLink when creating a new cluster>>, or you can <<enable-privatelink-endpoint-service-for-existing-clusters,enable PrivateLink for existing clusters>>.
2121

22-
TIP: Make sure to replace the variable values in the code examples on this page with your own values, before running the commands in the terminal or in a script.
23-
2422
== Requirements
2523

2624
* Install `rpk`.
@@ -131,6 +129,8 @@ rpk cloud byoc aws apply --redpanda-id=$CLUSTER_ID
131129

132130
== Enable PrivateLink endpoint service for existing clusters
133131

132+
CAUTION: As soon as PrivateLink is available on your VPC, all communication on existing Redpanda bootstrap server and broker ports is interrupted due to the change on the private DNS resolution. Make sure all applications running in your VPC are ready to start using the corresponding PrivateLink ports.
133+
134134
. In the Redpanda Cloud UI, go to the cluster overview and copy the cluster ID from the **Details** section.
135135
+
136136
[,bash]

modules/networking/pages/azure-private-link.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ Consider using Private Link if you have multiple virtual networks and require mo
1515

1616
After <<get-a-cloud-api-access-token,getting an access token>>, you can <<create-new-cluster-with-private-link-service-enabled,enable Private Link when creating a new cluster>>, or you can <<enable-private-link-service-for-existing-clusters,enable Private Link for existing clusters>>.
1717

18-
TIP: Make sure to replace the variable values in the code examples on this page with your own values before running the commands in the terminal or in a script.
19-
2018
== Requirements
2119

2220
* Install xref:manage:rpk/rpk-install.adoc[`rpk`].
@@ -152,6 +150,8 @@ rpk cloud byoc azure apply --redpanda-id=$CLUSTER_ID --subscription-id=$REDPANDA
152150

153151
=== Enable Private Link service for existing clusters
154152

153+
CAUTION: As soon as Private Link is available on your virtual network, all communication on existing Redpanda bootstrap server and broker ports is interrupted due to the change on the private DNS resolution. Make sure all applications running in your virtual network are ready to start using the corresponding Private Link ports.
154+
155155
. In the Redpanda Cloud UI, go to the cluster overview and copy the cluster ID from the **Details** section.
156156
+
157157
[,bash]

modules/networking/pages/configure-private-service-connect-in-cloud-ui.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
include::shared:partial$feature-flag.adoc[]
66

7-
NOTE: This guide is for configuring GCP Private Service Connect using the Redpanda Cloud UI. See xref:networking:gcp-private-service-connect.adoc[] if you want to set up this service using the API.
7+
NOTE: This guide is for configuring GCP Private Service Connect using the Redpanda Cloud UI. To configure and manage Private Service on an existing public cluster, you must use the xref:networking:gcp-private-service-connect.adoc[Redpanda Cloud API].
88

99
The Redpanda GCP Private Service Connect service provides secure access to Redpanda Cloud from your own VPC. Traffic over Private Service Connect does not go through the public internet because these connections are treated as their own private GCP service. While your VPC has access to the Redpanda VPC, Redpanda cannot access your VPC.
1010

modules/networking/pages/configure-privatelink-in-cloud-ui.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
include::shared:partial$feature-flag.adoc[]
66

7-
NOTE: This guide is for configuring AWS PrivateLink using the Redpanda Cloud UI. See xref:networking:aws-privatelink.adoc[Configure AWS PrivateLink for Redpanda Cloud] if you want to set up the endpoint service using the API.
7+
NOTE: This guide is for configuring AWS PrivateLink using the Redpanda Cloud UI. To configure and manage PrivateLink on an existing public cluster, you must use the xref:networking:aws-privatelink.adoc[Redpanda Cloud API].
88

99
The Redpanda AWS PrivateLink endpoint service provides secure access to Redpanda Cloud from your own VPC. Traffic over PrivateLink does not go through the public internet because these connections are treated as their own private AWS service. While your VPC has access to the Redpanda VPC, Redpanda cannot access your VPC.
1010

modules/networking/pages/gcp-private-service-connect.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
include::shared:partial$feature-flag.adoc[]
66

7-
NOTE: This guide is for configuring GCP Private Service Connect using the Redpanda Cloud API. See xref:networking:configure-private-service-connect-in-cloud-ui.adoc[Configure Private Service Connect in the Cloud UI] if you want to set up the endpoint service using the UI.
7+
NOTE: This guide is for configuring GCP Private Service Connect using the Redpanda Cloud API. To configure and manage Private Service Connect on an existing public cluster, you must use the Cloud API. See xref:networking:configure-private-service-connect-in-cloud-ui.adoc[Configure Private Service Connect in the Cloud UI] if you want to set up the endpoint service using the Redpanda Cloud UI.
88

99
The Redpanda GCP Private Service Connect service provides secure access to Redpanda Cloud from your own VPC. Traffic over Private Service Connect does not go through the public internet because a Private Service Connect connection is treated as its own private GCP service. While your VPC has access to the Redpanda VPC, Redpanda cannot access your VPC.
1010

@@ -193,6 +193,8 @@ Replace the following placeholders for the request body. Variables with a `byovp
193193

194194
== Enable Private Service Connect on an existing BYOC cluster
195195

196+
CAUTION: As soon as Private Service Connect is available on your VPC, all communication on existing Redpanda bootstrap server and broker ports is interrupted due to the change on the private DNS resolution. Make sure all applications running in your VPC are ready to start using the corresponding Private Service Connect ports.
197+
196198
. In the Redpanda Cloud UI, go to the cluster overview and copy the cluster ID from the **Details** section.
197199
+
198200
[,bash]

0 commit comments

Comments
 (0)