Skip to content

Iceberg data retention#1171

Merged
kbatuigas merged 5 commits intomainfrom
DOC-1176-iceberg-support-retention-period-for-iceberg-data
Jun 23, 2025
Merged

Iceberg data retention#1171
kbatuigas merged 5 commits intomainfrom
DOC-1176-iceberg-support-retention-period-for-iceberg-data

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented Jun 18, 2025

Description

This pull request updates documentation for Iceberg-related features, including clarifying catalog usage and adding a new section on Iceberg topic retention. These changes improve the accuracy and comprehensiveness of the documentation.

Updates to Iceberg documentation:

  • Navigation Update: Updated the link label in modules/ROOT/nav.adoc for consistency with other catalog integration docs.
  • Iceberg Topic Retention: Added a new section in modules/manage/partials/iceberg/about-iceberg-topics.adoc explaining the retention behavior of Iceberg-enabled topics. This includes details on how Iceberg tables persist beyond the configured retention policies of Redpanda topics and the conditions under which they can be deleted.

Resolves https://redpandadata.atlassian.net/browse/
Review deadline:

Page previews

About Iceberg Topics > Enable Iceberg integration > Iceberg data retention

Checks

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

@kbatuigas kbatuigas requested a review from a team as a code owner June 18, 2025 23:36
@netlify
Copy link
Copy Markdown

netlify bot commented Jun 18, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 8d5e75b
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/685609154ebd450008a34e29
😎 Deploy Preview https://deploy-preview-1171--redpanda-docs-preview.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 project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jun 19, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

The changes introduce a new section in the documentation explaining the retention behavior of Iceberg-enabled topics, clarifying that Iceberg table data is not subject to Redpanda topic retention policies and outlining the conditions under which Iceberg data is deleted. Additionally, a navigation label in the documentation index was updated to reflect expanded querying capabilities, now referencing both Snowflake and Open Catalog.

Assessment against linked issues

Objective Addressed Explanation
Clarify and document the retention period for Iceberg data (DOC-1176)

Suggested reviewers

  • micheleRP
  • Feediver1

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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/manage/partials/iceberg/about-iceberg-topics.adoc (1)

225-232: Fix capitalization and grammar in the new retention section.

  • Change the heading to Title Case: === Iceberg Topic Retention.

  • Adjust the sentence on line 227 for subject–verb agreement, e.g.:

    Data in Iceberg-enabled topics remains queryable indefinitely. The generated Iceberg tables do not follow the configured retention policies for the Redpanda topic itself.

    or

    Data in Iceberg-enabled topics remains queryable indefinitely. The generated Iceberg table data does not follow the configured retention policies for the Redpanda topic itself.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 47e4bd0 and 2cb91bc.

📒 Files selected for processing (2)
  • modules/ROOT/nav.adoc (1 hunks)
  • modules/manage/partials/iceberg/about-iceberg-topics.adoc (1 hunks)
🔇 Additional comments (1)
modules/ROOT/nav.adoc (1)

178-178: Navigation label updated to reflect broader catalog support.
The link text now includes "Open Catalog" to align with the expanded documentation on catalog integrations.

Copy link
Copy Markdown

@andrwng andrwng left a comment

Choose a reason for hiding this comment

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

LGTM


=== Iceberg topic retention

Data in Iceberg-enabled topics remains queryable as Iceberg tables indefinitely. The generated Iceberg table does not follow the configured retention policies for the Redpanda topic itself. The Iceberg table persists unless you:
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looking again, this kind of reads as though you can use Kafka to read Iceberg-enabled topics forever, which isn't true.

Maybe something like:

"Data in an Iceberg-enabled topic will be consumable from Kafka based on the configured Kafka retention policy. Conversely, data written to Iceberg will remain queryable as Iceberg tables indefinitely. The Iceberg table persists..."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Revised

Copy link
Copy Markdown
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.

lgtm!

@kbatuigas kbatuigas merged commit eca357b into main Jun 23, 2025
7 checks passed
@kbatuigas kbatuigas deleted the DOC-1176-iceberg-support-retention-period-for-iceberg-data branch June 23, 2025 20:29
JakeSCahill pushed a commit that referenced this pull request Jul 15, 2025
@coderabbitai coderabbitai bot mentioned this pull request Sep 19, 2025
4 tasks
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.

3 participants