Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Mar 24, 2025

Description

This pull request introduces multiple changes to integrate and document the Iceberg feature in Redpanda. The most important changes include updating the branches to track in the playbook, adding new navigation links for Iceberg documentation, and creating new documentation pages for Iceberg-related features.

This PR adds AsciiDoc pages that contain env-byoc page attributes that will cause Cloud-specific content to appear. (See redpanda-data/docs#1032 for how conditional directives delineate which content is specific to Cloud.)

Iceberg Integration Documentation:

  • modules/ROOT/nav.adoc: Added navigation links for Iceberg documentation, including sections on about Iceberg topics, using Iceberg catalogs, and querying Iceberg topics.
  • modules/get-started/pages/whats-new-cloud.adoc: Added a new entry for April 2025 announcing the beta release of Iceberg topics, detailing its benefits and supported platforms.

New Iceberg Documentation Pages:

Playbook Update:

  • local-antora-playbook.yml: Updated the branches to track in the Redpanda documentation repository, including the new '805-single-source-iceberg' branch.

API Documentation Update:

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 3 Apr

Page previews

What's New in Cloud
Manage > Iceberg (beta)
Manage > Cloud API > Use the Control Plane API with BYOC

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@netlify
Copy link

netlify bot commented Mar 24, 2025

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit cce0c9b
🔍 Latest deploy log https://app.netlify.com/sites/rp-cloud/deploys/67f065cc354eba0008cbd2e3
😎 Deploy Preview https://deploy-preview-240--rp-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@hyperlint-ai-deprecated
Copy link
Contributor

hyperlint-ai-deprecated bot commented Mar 24, 2025

PR Change Summary

Added new pages related to Iceberg integration with Redpanda, enhancing documentation for managing Iceberg topics.

  • Introduced 'About Iceberg Topics' page to explain integration with Apache Iceberg.
  • Added 'Query Iceberg Topics' page detailing data access from Iceberg-compatible tools.
  • Created an index page for Iceberg documentation.

Added Files

  • modules/manage/pages/iceberg/about-iceberg-topics.adoc
  • modules/manage/pages/iceberg/index.adoc
  • modules/manage/pages/iceberg/query-iceberg-topics.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@simon0191 simon0191 self-requested a review March 24, 2025 17:41
@kbatuigas kbatuigas marked this pull request as ready for review April 1, 2025 14:12
@kbatuigas kbatuigas requested a review from a team as a code owner April 1, 2025 14:12
@kbatuigas kbatuigas requested a review from mattschumpert April 1, 2025 14:50
:page-beta: true
:env-byoc: true

When you access Iceberg topics from a data lakehouse or other Iceberg-compatible tools, how you consume the data depends on the xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Iceberg mode] you've chosen for a topic, and whether you've registered a schema for the topic in the xref:manage:schema-reg/schema-reg-overview.adoc[Redpanda Schema Registry]. In either mode, you do not need to rely on complex ETL jobs or pipelines to access real-time data from Redpanda.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kbatuigas "In any mode" not "in either mode" (since we now have 3 modes)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be updating in a separate PR for 25.1


When you access Iceberg topics from a data lakehouse or other Iceberg-compatible tools, how you consume the data depends on the xref:manage:iceberg/about-iceberg-topics.adoc#enable-iceberg-integration[Iceberg mode] you've chosen for a topic, and whether you've registered a schema for the topic in the xref:manage:schema-reg/schema-reg-overview.adoc[Redpanda Schema Registry]. In either mode, you do not need to rely on complex ETL jobs or pipelines to access real-time data from Redpanda.

include::25.1@ROOT:manage:partial$iceberg/query-iceberg-topics.adoc[] No newline at end of file
Copy link
Contributor

@micheleRP micheleRP Apr 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this need 25.1 in the directive? Same for all. We should remove if not necessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing the version number caused build errors. I'll keep them here for now.

:env-byoc: true

include::25.1@ROOT:manage:partial$iceberg/use-iceberg-catalogs.adoc[]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kbatuigas I need to pull in the new 25.1 properties, then they'll get single sourced into cloud. So we might need to go back to update these links later.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Discussed in team meeting

Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@kbatuigas kbatuigas merged commit 7c66c28 into main Apr 4, 2025
7 checks passed
@kbatuigas kbatuigas deleted the DOC-805-Document-feature-Iceberg-Beta-on-Cloud branch April 4, 2025 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants