Skip to content

Commit d52eb6e

Browse files
micheleRPpaulohtb6
andauthored
DOC-1336 Document feature Expose NAT Gateway IP in the BYOC cluster UI (#361)
* DOC-1336 Document feature Expose NAT Gateway IP in the BYOC cluster UI * add location of Internet gateway field, style edits * add Dedicated support + minor edits * minor edit * incorporate review feedback * clarifying text * incorporate feedback from Camilo * add caution about public GCP clusters * add location in API * change from GET network to GET cluster * add to What's New # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc * incorporate review feedback * Add TS costs per cloud provider * Incorporate Camilo feedback + tidy up table * fix typo * Update modules/networking/pages/cloud-security-network.adoc Co-authored-by: Paulo Borges <[email protected]> * Update modules/networking/pages/cloud-security-network.adoc Co-authored-by: Paulo Borges <[email protected]> * incorporate doc review --------- Co-authored-by: Paulo Borges <[email protected]>
1 parent 1ab60ba commit d52eb6e

File tree

2 files changed

+40
-15
lines changed

2 files changed

+40
-15
lines changed

modules/get-started/pages/whats-new-cloud.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@ xref:manage:iceberg/about-iceberg-topics.adoc[Iceberg topics] are now generally
1717

1818
xref:get-started:cluster-types/byoc/azure/create-byoc-cluster-azure.adoc[BYOC for Azure] is now generally available (GA).
1919

20+
=== Allowlist NAT gateway IP
21+
22+
The xref:networking:cloud-security-network.adoc#nat-gateways[Redpanda NAT gateway IP address] is now provided in the Cloud UI and the Cloud API for BYOC and Dedicated clusters. If necessary, you can use this IP address to allowlist egress traffic from your Redpanda Connect data sources.
23+
2024
=== mTLS and SASL authentication for Kafka API on AWS
2125

2226
You can now enable mTLS and SASL authentication simultaneously for the Kafka API on AWS clusters. If you enable both mTLS and SASL on AWS clusters, Redpanda creates two distinct listeners: an mTLS listener operating on one port and a SASL listener operating on a different port.

modules/networking/pages/cloud-security-network.adoc

Lines changed: 36 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -167,25 +167,46 @@ When private service connectivity is enabled (AWS PrivateLink, Azure Private Lin
167167
|===
168168

169169

170-
== NAT gateways
170+
== NAT gateways
171171

172-
Redpanda Cloud clusters rely on outbound-only internet access to connect to the control plane, perform cluster upgrades, and deliver cluster telemetry to the control plane.
172+
A NAT (Network Address Translation) gateway allows resources in a private network to access the internet, while blocking inbound connections.
173173

174-
* For Dedicated and BYOC standard clusters on AWS and GCP, Redpanda provisions one NAT gateway and one internet gateway.
175-
* For Dedicated and BYOC standard clusters on Azure, Redpanda provisions one NAT gateway and one public IP prefix of 31 bits.
176-
* For BYOVPC, you decide how to provide access to the internet, because you fully manage the network.
174+
Redpanda Cloud clusters require outbound-only internet access for control plane connectivity, upgrades, and telemetry. The way NAT gateways are provisioned depends on your cloud provider and deployment type:
177175

178-
Without connectors, NAT-incurred costs should be relatively low. Redpanda Connect and Kafka Connect connectors can egress to the internet and incur high NAT data transfer costs.
176+
* *BYOVPC/BYOVNet:* You are responsible for providing internet access, as you fully manage the network.
177+
* *BYOC/Dedicated* on *AWS:* Redpanda provisions one NAT gateway and one internet gateway for outbound-only access.
178+
* *BYOC/Dedicated* on *Azure:* Redpanda provisions one NAT gateway and a `/31` public IP prefix (two usable IPs) for outbound-only access.
179+
* *BYOC/Dedicated* on *GCP:* Redpanda provisions one NAT gateway and one internet gateway for outbound-only access.
180+
181+
The following table summarizes when a NAT gateway is required:
179182

180183
|===
181-
| Use case | NAT gateway required?
184+
| Traffic type | NAT gateway required? | Notes
185+
186+
| Redpanda streaming traffic | No |
187+
| Redpanda Tiered Storage traffic | No | *AWS*: All connections are done through a VPC gateway endpoint in the VPC. BYOVPC customers must ensure that this VPC endpoint exists in the VPC and that routing rules are configured appropriately.
188+
189+
*Azure*: Three Private Link endpoints are used by Redpanda brokers to access Azure Blob Storage.
182190

183-
| Redpanda streaming traffic | No
184-
| Redpanda Tiered Storage traffic | No: VPC gateway endpoint used, no data transfer charges
185-
| Redpanda provisioning and telemetry | Yes: minimal usage for artifact downloads and metrics
186-
| Internet-facing connectors | Yes: incurs NAT data-transfer charges
191+
*GCP*: Tiered Storage data transfer is free within the same region.
192+
| Redpanda provisioning and telemetry | Yes | There is a minimal usage for artifact downloads and metrics.
193+
| Internet-facing connectors | Yes | Internet-facing connectors incur NAT data transfer charges.
187194
|===
188195

196+
[NOTE]
197+
====
198+
GCP public clusters use multiple NAT gateways with dynamic IP allocation. For GCP public clusters, do not use specific NAT gateway IP addresses for allowlisting or firewall rules.
199+
====
200+
201+
=== Allowlist the NAT gateway
202+
203+
Redpanda Connect and Kafka Connect connectors that egress to the internet can incur NAT data transfer costs. You can add the NAT gateway IP address to your data source allowlist, if needed.
204+
205+
Redpanda Data does not guarantee that the NAT gateway IP will remain static, but it is unlikely to change.
206+
207+
For BYOC and Dedicated clusters, you can find the NAT gateway IP on the cluster *Overview* page or in the response body of the xref:api:ROOT:cloud-controlplane-api.adoc#get-/v1/clusters/-id-[`GET /v1/clusters/\{id}`] API request.
208+
209+
189210
== Cloud provider network services
190211

191212
Each cloud provider offers specific network services integrated with Redpanda Cloud:
@@ -205,7 +226,7 @@ Redpanda Cloud creates a new DNS zone for each cluster in the control plane and
205226
+
206227
The Route 53-hosted DNS zone in the data plane has the following naming convention:
207228
+
208-
** BYOC/BYOVPC: `[cluster_id].byoc.prd.cloud.redpanda.com`
229+
** BYOC/BYOVPC/BYOVNet: `[cluster_id].byoc.prd.cloud.redpanda.com`
209230
** Dedicated: `[cluster_id].fmc.prd.cloud.redpanda.com`
210231
211232
* *Distributed denial of service (DDoS) protection*
@@ -222,7 +243,7 @@ _Security best practice:_ When using VPC peering, always reject all network traf
222243
+
223244
AWS PrivateLink lets you connect to cluster services using unidirectional TCP connections that client applications can only initiate. These applications can run from multiple customer-managed VPCs, even if their CIDR ranges overlap with the Redpanda cluster VPC.
224245
+
225-
AWS PrivateLink is configured against the Redpanda cluster's network load balancer. All client connections to cluster services pass through this load balancer. You configure PrivateLink with the Redpanda Cloud API or UI, and it is protected by an allowlist of principal ARNs during creation. Only those principals can create VPC endpoint attachments to the PrivateLink service.
246+
AWS PrivateLink is configured against the Redpanda cluster's network load balancer. All client connections to cluster services pass through this load balancer. You configure PrivateLink with the Redpanda Cloud UI or Cloud API, and it is protected by an allowlist of principal ARNs during creation. Only those principals can create VPC endpoint attachments to the PrivateLink service.
226247
--
227248
228249
Azure::
@@ -261,7 +282,7 @@ Unlike AWS and GCP, Azure charges $0.01 per GB transferred over a VNet peering,
261282
+
262283
Azure Private Link lets you connect to cluster services using an unidirectional TCP connection that can only be initiated by client applications. These applications can run from multiple customer-managed VNets, even if their CIDR ranges overlap with the Redpanda cluster VNet.
263284
+
264-
Redpanda configures Private Link against the cluster's Azure load balancer. All client connections to the Redpanda cluster services pass through this load balancer. You configure Private Link with the Redpanda Cloud API, and it is protected during creation by an allowlist of Azure subscription IDs. Only allowlisted subscriptions can create private endpoint attachments to the cluster's Private Link service.
285+
Redpanda configures Private Link against the cluster's Azure load balancer. All client connections to the Redpanda cluster services pass through this load balancer. You configure Private Link with the Redpanda Cloud UI or the Cloud API, and it is protected during creation by an allowlist of Azure subscription IDs. Only allowlisted subscriptions can create private endpoint attachments to the cluster's Private Link service.
265286
--
266287
267288
GCP::
@@ -289,7 +310,7 @@ _Security best practice:_ When using VPC peering, always reject all network traf
289310
+
290311
GCP Private Service Connect lets you connect to cluster services using a unidirectional TCP connection that can only be initiated by client applications. These applications can run from multiple customer-managed VPCs, even if their CIDR ranges overlap with the Redpanda cluster VPC.
291312
+
292-
Redpanda configures a Private Service Connect publisher or producer against the cluster's network load balancer. All client connections to the Redpanda cluster services pass through this load balancer. You configure a Private Service Connect publisher with the Redpanda Cloud API. It is protected during creation by a consumer accept list of GCP networks or project IDs. Only those consumers can create consumer endpoints to the Redpanda cluster's Private Service Connect published service.
313+
Redpanda configures a Private Service Connect producer against the cluster's network load balancer. All client connections to the Redpanda cluster services pass through this load balancer. You configure a Private Service Connect publisher with the Redpanda Cloud UI or the Cloud API. It is protected during creation by a consumer accept list of GCP networks or project IDs. Only those consumers can create consumer endpoints to the Redpanda cluster's Private Service Connect published service.
293314
--
294315
====
295316

0 commit comments

Comments
 (0)