DOC-1168 Private Link for Azure in UI #301
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 introduce a new documentation page detailing how to configure Azure Private Link for Redpanda Cloud clusters using the Cloud UI. Navigation references to this new guide are added under relevant sections for both BYOC and Dedicated Azure networking. Additionally, the metadata descriptions for several networking documentation pages are updated to explicitly mention Azure Private Link alongside other private networking options. A new feature announcement about Azure Private Link configuration in the UI is also added to the "What's New" section. No code or API changes are present; all modifications are documentation-focused. Sequence Diagram(s)sequenceDiagram
participant User
participant Redpanda Cloud UI
participant Azure VNet
User->>Redpanda Cloud UI: Access cluster creation/settings
User->>Redpanda Cloud UI: Select "Private connection" and enable Azure Private Link
Redpanda Cloud UI->>Azure VNet: Initiate Private Link endpoint service
Azure VNet-->>Redpanda Cloud UI: Confirm endpoint setup
Redpanda Cloud UI-->>User: Display connection URLs and status
User->>Azure VNet: Access Redpanda services via Private Link
Assessment against linked issues
Suggested reviewers
🪧 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: 1
🧹 Nitpick comments (11)
modules/networking/pages/azure-private-link.adoc (1)
2-2: Description updated for Cloud API—consider cross-linking UI guide
The new description correctly emphasizes the Cloud API setup. For consistency with the AWS PrivateLink docs and to help users find the UI-based instructions, consider adding a note near the top that points to the UI configuration guide.Example diff:
include::shared:partial$feature-flag.adoc[] + +NOTE: For UI-based configuration of Azure Private Link, see xref:networking:configure-private-link-in-ui.adoc[Configure Azure Private Link in the Cloud UI].modules/get-started/pages/whats-new-cloud.adoc (1)
12-14: Fix preposition in announcement sentence
The phrase “configure Azure Private Link to your … cluster” should use “for” rather than “to” for clearer grammar.Example diff:
- You can now xref:networking:configure-private-link-in-ui.adoc[configure Azure Private Link] to your BYOC or Dedicated cluster using the Cloud UI. + You can now xref:networking:configure-private-link-in-ui.adoc[configure Azure Private Link] for your BYOC or Dedicated cluster using the Cloud UI.modules/ROOT/nav.adoc (2)
34-34: New Azure Private Link UI navigation link added
The xref toconfigure-private-link-in-ui.adoccorrectly integrates the new guide under the BYOC Azure networking section. Please confirm that the referenced file path matches the actual file location. For consistency with other UI guides (e.g., AWS/GCP), consider specifying an explicit link title in square brackets or verifying naming conventions.
46-46: Add UI link for Dedicated Azure Private Link
This navigation entry mirrors the BYOC section and improves discoverability for Dedicated clusters. Ensure that the pathnetworking:configure-private-link-in-ui.adocaligns with the guide’s filename and consider adding a descriptive label in the brackets for clarity.modules/networking/pages/configure-private-link-in-ui.adoc (7)
4-4: Clarify “existing public cluster” scope
The NOTE refers to “existing public cluster,” which might overlap with new clusters or confuse readers about cluster types. Consider rephrasing to “existing cluster” or explicitly stating “clusters created without Private Link” to remove ambiguity.
6-6: Unify networking terminology
This paragraph mixes Azure (“VNet”) and AWS-style (“VPC”) terms. To avoid confusion, replace “Redpanda VPC” with “Redpanda virtual network” or add a brief note explaining that our service uses a VPC abstraction even in Azure.
8-12: Improve bullet specificity
- Prefix bullets with “Azure Private Link” for parallelism (e.g., “Azure Private Link allows overlapping…”).
- Ensure the CIDR-ranges xref displays as intended without trailing punctuation.
These are minor copy edits to align the style with surrounding docs.
15-17: Fix Azure CLI link syntax
The external link to the Azure CLI guide includes a caret (^) in the bracket, which may render as a footnote marker. Remove the caret for a clean label:https://...-latest[Azure CLI]
18-18: Standardize TIP admonition style
Rather than inline “TIP:”, consider using an Asciidoc admonition block for consistency across guides:[TIP] ==== In Kafka clients, set `connections.max.idle.ms` to a value less than 350 seconds. ====
20-26: Trim trailing whitespace and normalize list formatting
- Remove extra spaces at the ends of lines 24 and 25.
- Confirm that nested ordered sub-steps use consistent dot notation.
This cleanup will prevent rendering artifacts in the HTML/PDF outputs.
45-47: Convert disable step into ordered list
For consistency with the “Enable” sections, consider presenting the disable instruction as a numbered list item:. On the Cluster settings page, click *Disable* for Private Link. . Note: Existing connections close when disabled; re-enable to restore access.This aligns styling across provider sections.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
modules/ROOT/nav.adoc(2 hunks)modules/get-started/pages/whats-new-cloud.adoc(1 hunks)modules/networking/pages/aws-privatelink.adoc(1 hunks)modules/networking/pages/azure-private-link.adoc(1 hunks)modules/networking/pages/byoc/index.adoc(1 hunks)modules/networking/pages/configure-private-link-in-ui.adoc(1 hunks)modules/networking/pages/dedicated/index.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (6)
modules/networking/pages/dedicated/index.adoc (1)
2-2: Metadata description aligned
The description now correctly includes Azure Private Link alongside AWS PrivateLink and GCP Private Service Connect. This update is clear and matches the BYOC index page.modules/networking/pages/aws-privatelink.adoc (1)
2-2: Metadata description aligned with Cloud API
The updated description emphasizes setup via the Cloud API and matches the page title. The in-page note already points to the UI guide, maintaining consistency with Azure and GCP docs.modules/networking/pages/byoc/index.adoc (1)
2-2: Metadata description aligned
The description now includes Azure Private Link alongside AWS PrivateLink and GCP Private Service Connect. It’s consistent with the Dedicated networking page.modules/networking/pages/configure-private-link-in-ui.adoc (3)
27-32: Enable endpoint service for existing clusters
The steps are clear, correctly numbered, and follow the same pattern as the “new clusters” section. No changes needed here.
33-37: Access instructions and include macro
The “How to Connect” reference and the include path for the partial (private-links-access-rp-services-through-vpc.adoc) are accurate and consistent with other documentation.
39-43: Test connection section
Good use of an ordered header and partial include for the connection tests. The guidance on usingrpkor cURL is helpful and correctly referenced.
…t-for-Azure-Frontend # Conflicts: # modules/get-started/pages/whats-new-cloud.adoc
|
status: marking this as blocked until this fix: https://redpandadata.atlassian.net/browse/UX-218 |
Description
This pull request introduces support for configuring Azure Private Link through the Redpanda Cloud UI. It includes a new guide for Azure Private Link in the UI, updated navigation menus, and enhanced descriptions across related pages. It also removed the "Limited availability" label on Azure Private Link, so users no longer need to contact Support to use it in the Cloud API.
New Feature: Azure Private Link in the UI
modules/networking/pages/azure-private-link-in-ui.adoc: Added a new guide detailing how to configure Azure Private Link using the Redpanda Cloud UI. This includes setup instructions, requirements, testing, and disabling the service.Documentation Updates for Navigation
modules/ROOT/nav.adoc: Updated navigation to include links to the new Azure Private Link UI guide under both BYOC and Dedicated sections. [1] [2]Improved Descriptions for Clarity
modules/networking/pages/aws-privatelink.adoc: Updated the description to specify that the guide is for configuring AWS PrivateLink with the Cloud API.modules/networking/pages/azure-private-link.adoc: Updated the description and added a note linking to the new UI-based configuration guide for Azure Private Link.modules/networking/pages/byoc/index.adocandmodules/networking/pages/dedicated/index.adoc: Updated descriptions to include Azure Private Link alongside other private networking options. [1] [2]What's New Section
modules/get-started/pages/whats-new-cloud.adoc: Added an entry announcing the availability of Azure Private Link configuration in the UI.Resolves https://redpandadata.atlassian.net/browse/DOC-1168
Review deadline:
Page previews
Configure Azure Private Link in the Cloud UI
Checks