Skip to content

Conversation

@kbatuigas
Copy link
Contributor

@kbatuigas kbatuigas commented Jun 13, 2025

Description

This pull request introduces documentation updates for Redpanda's Iceberg integration, focusing on partitioning, authentication modes, dead-letter queues, and topic properties. The updates aim to improve clarity and provide additional guidance for users configuring Iceberg-related features.

Iceberg Partitioning and Configuration Updates:

Authentication Recommendations:

  • Added a recommendation to use oauth2 as the preferred authentication mode for REST catalogs in cloud environments. (modules/manage/partials/iceberg/use-iceberg-catalogs.adoc, [1]; modules/reference/pages/properties/cluster-properties.adoc, [2]

Dead-Letter Queue (DLQ) Configuration:

Topic Refresh Lag Configuration:

Cross-Reference Improvements:

  • Enhanced cross-references in topic properties documentation to guide users to relevant sections, such as managing dead-letter queues and custom partitioning. (modules/reference/pages/properties/topic-properties.adoc, [1]; [2]

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

Page previews

Query Iceberg Topics with Databricks Unity Catalog > Limitations
Topic Configuration Properties > redpanda.iceberg.target.lag.ms
Cloud > Use Iceberg Catalogs > Connect to REST Catalog > Set cluster properties
Cloud > Cluster Properties > iceberg_rest_catalog_authentication_mode

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 13, 2025 19:07
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 13, 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 documentation was updated in three areas related to Iceberg integration. The section on Databricks Unity Catalog was revised to remove references to the lack of support for partition evolution and the cluster property iceberg_default_partition_spec, and to reorganize unsupported data type listings for clarity. The documentation for using Iceberg REST catalogs was enhanced with cloud-specific recommendations for authentication and clearer instructions for managing secrets. Additionally, the cluster property documentation was updated to recommend the oauth2 authentication mode for Redpanda Cloud users. No functional or procedural changes were made.

Sequence Diagram(s)

No sequence diagrams are generated as the changes are limited to documentation updates and do not introduce or modify control flows or features.

Assessment against linked issues

Objective Addressed Explanation
Remove partition evolution limitation from Unity Catalog docs (DOC-1446)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found. All documentation updates align with the linked issue's objectives.

Possibly related PRs

Suggested reviewers

  • mattschumpert
  • 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.

@netlify
Copy link

netlify bot commented Jun 13, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 99f53dc
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/68504828c28b37000849ca42
😎 Deploy Preview https://deploy-preview-1163--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.

Copy link
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/reference/pages/properties/cluster-properties.adoc (1)

2069-2073: Good cloud-specific recommendation
The new ifdef::env-cloud[] block correctly highlights that OAuth2 is preferred for REST catalog authentication in cloud environments.

Optionally, consider appending a xref to the secret creation guide (e.g. manage/partials/iceberg/use-iceberg-catalogs.adoc) so users can jump directly from this recommendation to configuring iceberg_rest_catalog_client_id and iceberg_rest_catalog_client_secret.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9d666a8 and 5101d27.

📒 Files selected for processing (3)
  • modules/manage/pages/iceberg/iceberg-topics-databricks-unity.adoc (2 hunks)
  • modules/manage/partials/iceberg/use-iceberg-catalogs.adoc (2 hunks)
  • modules/reference/pages/properties/cluster-properties.adoc (1 hunks)
🔇 Additional comments (8)
modules/manage/partials/iceberg/use-iceberg-catalogs.adoc (7)

63-67: Add cloud-specific recommendation for oauth2 authentication mode.

Introducing an ifdef::env-cloud[] block to recommend using oauth2 in cloud environments aligns docs with best practices. Confirm that this aligns with the corresponding property docs in cluster-properties.adoc.


68-75: Remove AsciiDoc block delimiters for clarity.

The removal of -- separators refines the list formatting, but verify that the nested list items render correctly in all outputs.


76-77: Add caution for bearer token usage.

The new note clarifies that bearer tokens are not refreshed, highlighting security considerations for ad hoc or testing scenarios.


112-114: Ensure correct AsciiDoc tab block formatting.

A + was added before the block delimiter; validate that the [tabs] and block syntax render as intended in the generated documentation.


119-123: Expand placeholders guidance for secret creation.

Providing explicit instructions for <secret-name> and <secret-value> enhances usability and reduces misconfiguration risk.


127-133: Streamline Cloud API instructions.

Added + markers and removed separators around the Cloud API section; confirm the resulting layout maintains proper indentation and readability.


140-150: Detail secret payload parameters.

Listing all required placeholders and their patterns in this section ensures users supply valid values when creating secrets via the Cloud API.

modules/manage/pages/iceberg/iceberg-topics-databricks-unity.adoc (1)

30-41: Reposition unsupported data types listing.

The table of unsupported data types has been moved to appear immediately after the Limitations heading, improving the document’s flow and clarity.

@kbatuigas kbatuigas requested review from bharathv June 13, 2025 20:17

== Limitations

The following data types are not currently supported for managed Iceberg tables:

Choose a reason for hiding this comment

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

@nvartolomei this looks correct me to based on recent slack convos but can you take a quick 👀 , please?

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.

lgtm!

@kbatuigas kbatuigas force-pushed the DOC-1446-unity-catalog-supports-partition-evolution-with-ex branch from 81bdd3f to 9d21596 Compare June 16, 2025 16:05
Co-authored-by: Michele Cyran <michele@redpanda.com>
@kbatuigas kbatuigas merged commit ad1a89e into main Jun 16, 2025
7 checks passed
@kbatuigas kbatuigas deleted the DOC-1446-unity-catalog-supports-partition-evolution-with-ex branch June 16, 2025 16:41
JakeSCahill pushed a commit that referenced this pull request Jul 15, 2025
Co-authored-by: Michele Cyran <michele@redpanda.com>
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.

5 participants