Add BYOVPC support for Iceberg REST catalogs in single-sourced docs #1140
Conversation
✅ Deploy Preview for redpanda-docs-preview 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 📝 WalkthroughWalkthroughThis change updates the Antora playbook to reference a specific feature branch in the cloud-docs repository, targeting documentation for the Iceberg on Cloud BYOVPC GA (AWS, GCP) feature. Additionally, the Iceberg catalog documentation is revised: a beta feature note is removed, and a new note is added for non-cloud (BYOVPC) environments, clarifying secrets management requirements and providing guidance for AWS and GCP clusters. No changes were made to code or exported entities; all modifications are limited to documentation and configuration references. Sequence Diagram(s)Assessment against linked issues
Possibly related PRs
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (2)
local-antora-playbook.yml (1)
19-21: Consistent YAML list notation for branches
While a single string is valid, for consistency with other entries (which use lists), consider changing thebranchesfield to a sequence literal.- - url: https://github.com/redpanda-data/cloud-docs - branches: 'DOC-1222-Document-feature-Iceberg-on-Cloud-BYOVPC-GA-AWS-GCP' + - url: https://github.com/redpanda-data/cloud-docs + branches: + - DOC-1222-Document-feature-Iceberg-on-Cloud-BYOVPC-GA-AWS-GCPmodules/manage/partials/iceberg/use-iceberg-catalogs.adoc (1)
14-21: Use explicit attribute in endif directive
For clarity and to more closely mirror your openingifndef::env-cloud[], consider closing withendif::env-cloud[]instead of the genericendif::[].- endif::[] + endif::env-cloud[]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
local-antora-playbook.yml(1 hunks)modules/manage/partials/iceberg/use-iceberg-catalogs.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - redpanda-docs-preview
- GitHub Check: Header rules - redpanda-docs-preview
- GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (1)
modules/manage/partials/iceberg/use-iceberg-catalogs.adoc (1)
14-21: Well-scoped BYOVPC secrets management note
The new conditional note clearly informs non-cloud (BYOVPC) users about enabling secrets management and links to the appropriate AWS and GCP guides. This enhances the documentation for GA status.
kbatuigas
changed the title
Co-authored-by: Joyce Fee <[email protected]>
…1140) Co-authored-by: Joyce Fee <[email protected]>
Description
Related PR: redpanda-data/cloud-docs#313
This pull request introduces updates to Redpanda's documentation, focusing on Iceberg integration and related configurations. The changes include updates to branch references, new instructions for Azure cluster configurations, and removal of outdated beta feature notes for Iceberg in Redpanda Cloud. Below are the most important changes grouped by theme:
Documentation Updates for Iceberg Integration:
Branch Reference Update: Updated the branch reference for
redpanda-data/cloud-docsinlocal-antora-playbook.ymlto reflect theDOC-1222-Document-feature-Iceberg-on-Cloud-BYOVPC-GA-AWS-GCPbranch.New Azure Configuration Instructions: Added detailed steps for adding public IPs or subnet IDs to the allow list for Azure clusters. This includes a
curlcommand example for using the Control Plane API to configure subnet IDs. [1] [2]Removal of Deprecated Information:
Configuration Prerequisites:
Resolves https://redpandadata.atlassian.net/browse/
Review deadline: 30 May
Page previews
Use Iceberg Catalogs > Prerequisites
About Iceberg Topics > Access Iceberg data
Query Iceberg Topics > Access Iceberg tables
Checks