DOC-1336 Document feature Expose NAT Gateway IP in the BYOC cluster UI #361
Conversation
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe changes update documentation in two areas. The BYOC: Azure cluster type documentation was revised to replace the term "BYOVPC" with "BYOVNet" for accuracy and consistency. Separately, the NAT gateway section in the cloud security networking documentation was rewritten for clarity: it now provides a clearer definition of NAT gateways, specifies their use across different cloud providers and deployment types, introduces a summary table for NAT gateway requirements, and adds guidance on allowlisting NAT gateway IPs for BYOC clusters. Minor rewording and restructuring were made for improved readability and flow. Estimated code review effort2 (~15 minutes) Possibly related PRs
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
modules/networking/pages/cloud-security-network.adoc (1)
177-178: Clarify the Azure bullet (“public IP prefix (31 bits)”).Readers may not immediately recognise that a /31 prefix is required for the Azure NAT gateway. Consider spelling it out:
-* *BYOC/Dedicated on Azure:* Redpanda provisions one NAT gateway and one public IP prefix (31 bits). +* *BYOC/Dedicated on Azure:* Redpanda provisions one NAT gateway and a /31 public IP prefix (two usable addresses).This removes the parenthetical maths and matches Azure terminology.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
modules/get-started/pages/cluster-types/byoc/azure/index.adoc(1 hunks)modules/networking/pages/cloud-security-network.adoc(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
Learnt from: micheleRP
PR: redpanda-data/cloud-docs#267
File: modules/manage/pages/maintenance.adoc:63-64
Timestamp: 2025-04-25T01:42:09.318Z
Learning: The timeline for major upgrade notifications (180 days in advance) was intentionally removed from the Redpanda Cloud maintenance documentation, even though it was mentioned in the PR objectives.
Learnt from: david-yu
PR: redpanda-data/cloud-docs#338
File: modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc:74-75
Timestamp: 2025-06-24T03:31:29.345Z
Learning: User david-yu indicated that the standard Azure zones format using plain numbers like "1", "2", "3" is not valid for their specific Azure BYOVNet setup, suggesting there may be specific tooling or API requirements that expect region-prefixed zone names like "centralus-az1".
modules/get-started/pages/cluster-types/byoc/azure/index.adoc (1)
Learnt from: david-yu
PR: #338
File: modules/get-started/pages/cluster-types/byoc/azure/vnet-azure.adoc:74-75
Timestamp: 2025-06-24T03:31:29.345Z
Learning: User david-yu indicated that the standard Azure zones format using plain numbers like "1", "2", "3" is not valid for their specific Azure BYOVNet setup, suggesting there may be specific tooling or API requirements that expect region-prefixed zone names like "centralus-az1".
modules/networking/pages/cloud-security-network.adoc (1)
Learnt from: micheleRP
PR: #267
File: modules/manage/pages/maintenance.adoc:91-92
Timestamp: 2025-04-25T01:41:57.162Z
Learning: The notification timeline for Redpanda Cloud deprecations has been deliberately removed from the documentation, even though the PR summary mentioned a 180-day advance notice period.
🔇 Additional comments (1)
modules/get-started/pages/cluster-types/byoc/azure/index.adoc (1)
2-2: Check for lingering “BYOVPC” references inside the page body.The short-description now says “…BYOVNet…”, which is correct.
Make sure every paragraph, heading, example, and UI screenshot in this page (and any fragments it includes) has also been updated from BYOVPC → BYOVNet to avoid mixed terminology.
| | Internet-facing connectors | Yes (incurs NAT data transfer charges) | ||
| |=== | ||
|
|
||
| Without connectors, NAT-incurred costs should be relatively low. However, Redpanda Connect and Kafka Connect connectors that egress to the internet can incur higher NAT data transfer costs. |
There was a problem hiding this comment.
costs to where? the provider or redpanda itself?
There was a problem hiding this comment.
@c4milo is this correct: "Without connectors, NAT-incurred costs from your cloud provider should be relatively low." i.e., the costs come from the cloud provider?
There was a problem hiding this comment.
Let's remove any mention of cost, it creates more questions than what it answers.
There was a problem hiding this comment.
The table is also explaining it well enough. I really liked it!
This was incorporated |
|
|
||
| You can find the NAT gateway IP address on the cluster *Overview* page on the *Internet gateway* field. Add this address to your data source allowlist, if needed. While Redpanda Data does not guarantee the address will remain static, it is unlikely to change. | ||
|
|
||
| The *Internet gateway* field is available for BYOC clusters (including BYOVPC/BYOVNet) and Dedicated clusters. |
There was a problem hiding this comment.
Since we are documenting the feature as NAT Gateway, @andresaristizabal, maybe we should probably rename it in API and UI. NAT Gateway is also more correct since an Internet gateway is a router and also has a public IP but it is not the IP used to reach external services, but to route the NAT gateway traffic to the Internet.
| * *BYOC/Dedicated on Azure:* Redpanda provisions one NAT gateway and a /31 public IP prefix (two usable IPs). | ||
| * *BYOVPC/BYOVNet:* You are responsible for providing internet access, as you fully manage the network. | ||
|
|
||
| The following table summarizes when a NAT gateway is required: |
There was a problem hiding this comment.
After testing and debugging this, @c4milo found that the public cluster in GCP has multiple gateways and does not behave in the same way as other cloud providers. Therefore, we should add an alert for this case. For example:
Don't use NAT gateway IPs for public clusters in GCP.
While we fix/handle this case.
There was a problem hiding this comment.
Please check the wording and location of the new Caution note here.
micheleRP
force-pushed
the
DOC-1336-Document-feature-Expose-NAT-Gateway-IP-in-the-BYOC-Cluster-UI
branch
from
5e1e97f to
b5a0cfa
Compare
paulohtb6
left a comment
paulohtb6
left a comment
There was a problem hiding this comment.
No blockers. Only me being annoying :D
# Conflicts: # modules/get-started/pages/whats-new-cloud.adoc # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc
Co-authored-by: Paulo Borges <[email protected]>
Co-authored-by: Paulo Borges <[email protected]>
micheleRP
force-pushed
the
DOC-1336-Document-feature-Expose-NAT-Gateway-IP-in-the-BYOC-Cluster-UI
branch
from
24b85bb to
ab802b4
Compare
micheleRP
deleted the
DOC-1336-Document-feature-Expose-NAT-Gateway-IP-in-the-BYOC-Cluster-UI
branch
Description
This pull request adds information about NAT gateway IP addresses for BYOC clusters.
modules/networking/pages/cloud-security-network.adoc: Added a note explaining how to find the NAT gateway IP address for BYOC clusters in the Redpanda Cloud UI and its usage for allowlisting. Clarified that the NAT gateway IP is unlikely to change but is not guaranteed to remain static.Terminology updates:
modules/get-started/pages/cluster-types/byoc/azure/index.adoc: Changed "BYOVPC" to "BYOVNet" in the description to align with updated terminology.modules/networking/pages/cloud-security-network.adoc: Updated references from "BYOVPC" to "BYOVNet" in the networking documentation for Azure clusters.Resolves https://redpandadata.atlassian.net/browse/DOC-1336
Review deadline:
Page previews
https://deploy-preview-361--rp-cloud.netlify.app/redpanda-cloud/networking/cloud-security-network/#nat-gateways
Checks