Skip to content

Commit 89e9c19

Browse files
authored
DOC-774 doc best practices with private link (#247)
1 parent 2cf8809 commit 89e9c19

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

modules/networking/pages/aws-privatelink.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ After <<get-a-cloud-api-access-token,getting an access token>>, you can <<create
2424
* In this guide, you use the xref:manage:api/cloud-api-overview.adoc[Redpanda Cloud API] to enable the Redpanda endpoint service for your clusters. Follow the steps below to <<get-an-access-token,get an access token>>.
2525
* Use the https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[AWS CLI^] to create a new client VPC or modify an existing one to use the PrivateLink endpoint.
2626

27+
TIP: In Kafka clients, set `connections.max.idle.ms` to a value less than 350 seconds.
28+
2729
== Get a Cloud API access token
2830

2931
include::networking:partial$private-links-api-access-token.adoc[]

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,16 @@ 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+
To learn more about Azure Private Link, see the https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview[Azure documentation].
19+
1820
== Requirements
1921

2022
* Install xref:manage:rpk/rpk-install.adoc[`rpk`].
2123
* Install `jq` [https://jqlang.org/download/], which is used to parse JSON values from API responses.
2224
* You will use the https://learn.microsoft.com/en-us/cli/azure/[Azure CLI^] to authenticate with Azure and configure resources in your Azure account.
2325
* You will use the xref:deploy:deployment-option/cloud/api/cloud-api-overview.adoc[Redpanda Cloud API] to enable the Redpanda Private Link service for your clusters. Follow the steps on this page to <<get-a-cloud-api-access-token, get an access token>>.
2426

25-
To learn more about Azure Private Link, see the https://learn.microsoft.com/en-us/azure/private-link/private-link-service-overview[Azure documentation].
27+
TIP: In Kafka clients, set `connections.max.idle.ms` to a value less than 240 seconds.
2628

2729
== Set up Redpanda Private Link Service
2830

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Consider using the endpoint service if you have multiple VPCs and could benefit
1717
* Your Redpanda cluster and VPC must be in the same region.
1818
* Use the https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html[AWS CLI] to create a new client VPC or modify an existing one to use the PrivateLink endpoint.
1919

20+
TIP: In Kafka clients, set `connections.max.idle.ms` to a value less than 350 seconds.
21+
2022
== Enable endpoint service for existing clusters
2123

2224
. In the Redpanda Cloud UI, select your https://cloud.redpanda.com/clusters[cluster^], and go to the *Cluster settings* page.

0 commit comments

Comments
 (0)