Skip to content

Commit a632ef1

Browse files
authored
DOC-1678 DNS forwarding (#425)
* DOC-1678 DNS forwarding * fix formatting * coderabbit suggestions * edits * recommend Route 53
1 parent b0277db commit a632ef1

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

modules/networking/pages/aws-privatelink.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ After <<get-a-cloud-api-access-token,getting an access token>>, you can <<create
2828

2929
TIP: In Kafka clients, set `connections.max.idle.ms` to a value less than 350 seconds.
3030

31+
NOTE: Enabling PrivateLink changes private DNS behavior for your cluster. Before configuring connections, review <<dns-resolution-with-privatelink>>.
32+
3133
== Get a Cloud API access token
3234

3335
include::networking:partial$private-links-api-access-token.adoc[]
@@ -188,6 +190,10 @@ curl -X GET \
188190
$PUBLIC_API_ENDPOINT/v1/clusters/$CLUSTER_ID | jq '.cluster.aws_private_link.status | {service_name, service_state}'
189191
----
190192

193+
== DNS resolution with PrivateLink
194+
195+
include::networking:partial$dns_resolution.adoc[]
196+
191197
== Configure PrivateLink connection to Redpanda Cloud
192198

193199
When you have a PrivateLink-enabled cluster, you can create an endpoint to connect your VPC and your cluster.
@@ -203,6 +209,8 @@ For example, if the bootstrap server URL is: `seed-3da65a4a.cki01qgth38kk81ard3g
203209
CLUSTER_DOMAIN=<cluster_domain>
204210
----
205211

212+
NOTE: Use `<cluster_domain>` as the domain you target with your DNS conditional forward (optionally also `*.<cluster_domain>` if your DNS platform requires a wildcard).
213+
206214
=== Get name of PrivateLink endpoint service
207215

208216
The service name is required to <<create-vpc-endpoint,create VPC private endpoints>>. Run the following command to get the service name:

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ Consider using the endpoint service if you have multiple VPCs and could benefit
2323

2424
TIP: In Kafka clients, set `connections.max.idle.ms` to a value less than 350 seconds.
2525

26+
== DNS resolution with PrivateLink
27+
28+
include::networking:partial$dns_resolution.adoc[]
29+
2630
== Enable endpoint service for existing clusters
2731

2832
. In the Redpanda Cloud UI, select your https://cloud.redpanda.com/clusters[cluster^], and go to the *Cluster settings* page.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
PrivateLink changes how DNS resolution works for your cluster. When you query cluster hostnames outside the VPC that contains your PrivateLink endpoint, DNS may return private IP addresses that aren't reachable from your location.
2+
3+
To resolve cluster hostnames from other VPCs or on-premise networks, set up DNS forwarding using Route 53 Resolver:
4+
5+
. In the VPC that contains your PrivateLink endpoint, create a Route 53 Resolver inbound endpoint.
6+
+
7+
Ensure that the inbound endpoint's security group allows inbound UDP/TCP port 53 from each VPC or on-prem network that will forward queries.
8+
9+
. In each other VPC that must resolve the cluster domain, create a Resolver outbound endpoint and a forwarding rule for `<cluster_domain>` that targets the inbound endpoint IPs from the previous step. Associate the rule to those VPCs.
10+
+
11+
The cluster domain is the suffix after the seed hostname. For example, if your bootstrap server URL is: `seed-3da65a4a.cki01qgth38kk81ard3g.byoc.dev.cloud.redpanda.com:9092`, then `cluster_domain` is: `cki01qgth38kk81ard3g.byoc.dev.cloud.redpanda.com`.
12+
. For on-premises DNS, create a conditional forwarder for `<cluster_domain>` that forwards to the inbound endpoint IPs from the earlier step (over VPN/Direct Connect).
13+
+
14+
[IMPORTANT]
15+
====
16+
Do not configure forwarding rules to target the VPC's Amazon-provided DNS resolver (VPC base CIDR + 2). Rules must target the IP addresses of Route 53 Resolver endpoints.
17+
====

0 commit comments

Comments
 (0)