Single source Iceberg+Snowflake integration doc for Cloud #1131
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 📝 WalkthroughWalkthroughThe changes update the Antora playbook configuration to source documentation content from a specific feature branch ( Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Redpanda Cloud
participant rpk/Cloud API
User->>Documentation: Access Snowflake integration guide
alt Cloud environment
Documentation->>User: Show cloud-specific prerequisites and steps
User->>Redpanda Cloud: Manage secrets via rpk/Cloud API
User->>Redpanda Cloud: Configure cluster and topics (rpk/Cloud UI/API)
else Non-cloud environment
Documentation->>User: Show non-cloud prerequisites and steps
User->>Redpanda: Update static configuration and restart cluster
User->>Redpanda: Configure topics via rpk
end
Assessment against linked issues
Possibly related PRs
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
🔭 Outside diff range comments (2)
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc (2)
27-34:⚠️ Potential issueCorrect AsciiDoc block delimiters for IAM setup steps
The list of IAM setup steps is wrapped with--delimiters, which are not standard AsciiDoc block markers. Replace with----for a literal block, or remove delimiters and rely on the.-prefixed list syntax:- -- - . If you don't already have one, create an IAM policy that gives Open Catalog read and write access to your S3 bucket. - . Create an IAM role and attach the IAM policy to the role. - . After creating a new catalog in Open Catalog, grant the catalog's AWS IAM user access to the S3 bucket. - -- + ---- + . If you don't already have one, create an IAM policy that gives Open Catalog read and write access to your S3 bucket. + . Create an IAM role and attach the IAM policy to the role. + . After creating a new catalog in Open Catalog, grant the catalog's AWS IAM user access to the S3 bucket. + ----
99-134: 🛠️ Refactor suggestionAlign non-cloud IAM and configuration blocks with AsciiDoc conventions
The non-cloud section also uses--around placeholder lists. Replace these with standard AsciiDoc block markers or remove them:- -- - - `<snowflake-orgname>` and `<open-catalog-account-name>`: Your Open Catalog account URI... - -- + ---- + - `<snowflake-orgname>` and `<open-catalog-account-name>`: Your Open Catalog account URI... + ----Additionally, elevate the “You must restart your cluster” instruction into an important note (e.g.,
IMPORTANT:or an admonition) to ensure users don’t overlook it.
🧹 Nitpick comments (3)
local-antora-playbook.yml (1)
19-21: Verify branch update in Antora playbook and maintain type consistency
Thebranchesfor thecloud-docssource has been changed to a quoted scalar. Confirm that the branchDOC-1389-cloud-snowflake-secrets-docexists in the remote repository. For consistency with otherbranchesentries that use list syntax or unquoted scalars, consider:- branches: 'DOC-1389-cloud-snowflake-secrets-doc' + branches: [DOC-1389-cloud-snowflake-secrets-doc]modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc (2)
16-23: Validate Asciidoctor conditional blocks and bullet clarity
The newifdef::env-cloud[]/ifndef::env-cloud[]sections correctly split cloud vs. non-cloud prerequisites. Ensure theenv-cloudattribute is defined in the playbook so the correct content renders.
Additionally, refine the new bullet for consistency:
- Change
"You need the S3 bucket URI, so you can configure it as external storage for Open Catalog."
to
"You need the S3 bucket URI to configure it as external storage for Open Catalog."
68-98: Review cloud cluster configuration code blocks and placeholders
The cloud-specific cluster configuration section correctly uses continuation markers (+) before the[,bash]and[,bash,role=no-copy]blocks. Confirm the placeholders (<snowflake-orgname>,<open-catalog-account-name>, etc.) match the examples provided. For readability, consider breaking the longrpk cluster config setline into multiple lines or indenting parameters in the generated output.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
local-antora-playbook.yml(1 hunks)modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc(4 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 (2)
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc (2)
10-11: Ensure single-source tagging is correctly recognized
The// tag::single-source[]marker has been added to denote the start of the single-source section. Verify that your Antora tooling and custom extensions recognize these comment tags and properly include/exclude the enclosed content.
274-274: Confirm single-source section closure
The// end::single-source[]tag correctly closes the single-source block. Ensure there are no stray characters or whitespace before or after this line that could prevent the tag from being recognized.
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc
Outdated
Show resolved
Hide resolved
modules/manage/pages/iceberg/redpanda-topics-iceberg-snowflake-catalog.adoc
Outdated
Show resolved
Hide resolved
Co-authored-by: Michele Cyran <[email protected]>
kbatuigas
deleted the
DOC-1389-Iceberg-on-Cloud-Single-source-Snowflake-doc
branch
Description
This pull request introduces changes to support documenting the integration of Redpanda topics with Snowflake using Iceberg tables. Key updates include switching the branch for the
cloud-docsrepository in the Antora playbook, addingconditional instructions for Redpanda Cloud users, and enhancing topic configuration details for Iceberg integration.
See accompanying cloud PR: redpanda-data/cloud-docs#302
Below is a breakdown of the most important changes:
Antora Playbook Update
cloud-docsrepository inlocal-antora-playbook.ymltoDOC-1389-cloud-snowflake-secrets-doc, replacing the previousmainbranch.Documentation Enhancements for Iceberg-Snowflake Integration
rpkor the Cloud API for secrets management and cluster configuration. Non-cloud users are directed to configure object storage and enable Tiered Storage.rpk, the Control Plane API, or the Data Plane API.Code Tagging
// tag::single-source[]and// end::single-source[]markers to encapsulate the single-source documentation section. [1] [2]Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
Cloud: https://deploy-preview-1131--redpanda-docs-preview.netlify.app/redpanda-cloud/manage/iceberg/redpanda-topics-iceberg-snowflake-catalog/
Checks