Skip to content

Commit

Permalink
DOC-662 interrupted communication after private networking (#154)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
micheleRP authored Dec 12, 2024
1 parent f014761 commit 9e164c0
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 8 deletions.
6 changes: 3 additions & 3 deletions modules/networking/pages/aws-privatelink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

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

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.
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.

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.

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

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>>.

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.

== Requirements

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

== Enable PrivateLink endpoint service for existing clusters

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.

. In the Redpanda Cloud UI, go to the cluster overview and copy the cluster ID from the **Details** section.
+
[,bash]
Expand Down
4 changes: 2 additions & 2 deletions modules/networking/pages/azure-private-link.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ Consider using Private Link if you have multiple virtual networks and require mo

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>>.

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.

== Requirements

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

=== Enable Private Link service for existing clusters

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.

. In the Redpanda Cloud UI, go to the cluster overview and copy the cluster ID from the **Details** section.
+
[,bash]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

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.
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].

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

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.
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].

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.

Expand Down
4 changes: 3 additions & 1 deletion modules/networking/pages/gcp-private-service-connect.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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

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.
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.

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.

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

== Enable Private Service Connect on an existing BYOC cluster

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.

. In the Redpanda Cloud UI, go to the cluster overview and copy the cluster ID from the **Details** section.
+
[,bash]
Expand Down

0 comments on commit 9e164c0

Please sign in to comment.