Skip to content

Update 26.2 (client compatibility, Iceberg translation) single sourcing for Cloud - #1857

Open
kbatuigas wants to merge 3 commits into
mainfrom
DOC-2312-2311-2290-26.2-single-source
Open

Update 26.2 (client compatibility, Iceberg translation) single sourcing for Cloud#1857
kbatuigas wants to merge 3 commits into
mainfrom
DOC-2312-2311-2290-26.2-single-source

Conversation

@kbatuigas

@kbatuigas kbatuigas commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Description

Related: redpanda-data/cloud-docs#657

This pull request updates documentation to unify and clarify instructions for both self-hosted and cloud environments, primarily by removing conditional content that previously differentiated between the two. It also makes version requirements and feature availability clearer for Redpanda features such as Kafka client compatibility and Iceberg schema translation.

Documentation unification and clarification:

  • Removed environment-specific (env-cloud) conditionals from the Kafka client compatibility section, presenting a single, unified explanation of validated clients and compatibility for both self-hosted and cloud users.
  • Unified and clarified instructions for configuring Iceberg schema translation, including section-based syntax and configuration examples, so that both cloud and self-hosted environments receive the same guidance.

Version requirement and feature availability updates:

  • Added explicit notes about version requirements for advanced Iceberg configuration options, ensuring users are aware that certain settings require all brokers to be running Redpanda version 26.2 or later.
  • Clarified that Schema Registry contexts are enabled by default (and since when), and provided consistent guidance for both environments on how to configure and use contexts.
  • Cleaned up lingering conditional blocks at the end of the Iceberg schema documentation for consistency.

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

Page previews

These pages are single-sourced, and this PR contains the source/env-cloud conditional changes. Review both renderings:

Cloud (single-sourced) rendering — for SME review of Cloud accuracy. Built by the tandem cloud-docs PR #657, which pulls this branch and applies the env-cloud attribute:

Self-managed (streaming) rendering:

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 July 31, 2026 00:18
@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit e0a2c28
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a6be9db052ff80008371ad8
😎 Deploy Preview https://deploy-preview-1857--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

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

📝 Walkthrough

Walkthrough

Kafka client documentation now uses environment-independent validation text and grouped Go/Python client lists. Iceberg schema documentation now includes translation and Schema Registry context guidance for cloud environments, while broker version gating and version-specific wording remain limited to self-managed deployments.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: jakescahill

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the Redpanda 26.2 documentation changes for Kafka client compatibility and Iceberg translation single-sourcing.
Description check ✅ Passed The description explains the documentation changes and includes page previews and checks, but the Jira ticket, review deadline, and check selection remain incomplete.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2312-2311-2290-26.2-single-source

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@modules/manage/pages/iceberg/specify-iceberg-schema.adoc`:
- Around line 440-445: Update the Schema Registry context guidance in the
env-cloud and non-cloud documentation blocks to explicitly describe whether key
decoding modes schema_id_prefix and schema_latest resolve schemas using the
configured Schema Registry context; if they do, document that lookup behavior
alongside the existing context and qualified-subject explanation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 51ad457d-5632-49c5-815f-47a428deb763

📥 Commits

Reviewing files that changed from the base of the PR and between 32c36c6 and e0a2c28.

📒 Files selected for processing (2)
  • modules/develop/pages/kafka-clients.adoc
  • modules/manage/pages/iceberg/specify-iceberg-schema.adoc
💤 Files with no reviewable changes (1)
  • modules/develop/pages/kafka-clients.adoc

Comment on lines +440 to +445
ifndef::env-cloud[]
Starting in Redpanda 26.2, Schema Registry contexts are enabled by default. See xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry contexts] to learn about contexts and qualified subject naming before you configure this property.
endif::[]
ifdef::env-cloud[]
Schema Registry contexts are enabled by default. See xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry contexts] to learn about contexts and qualified subject naming before you configure this property.
endif::[]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

Document Schema Registry context behavior for key decoding.

This section only names the legacy value modes, while this page now also supports key:mode=schema_id_prefix and key:mode=schema_latest. Clarify whether key schema lookups use the configured context, and document the behavior if they do.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/manage/pages/iceberg/specify-iceberg-schema.adoc` around lines 440 -
445, Update the Schema Registry context guidance in the env-cloud and non-cloud
documentation blocks to explicitly describe whether key decoding modes
schema_id_prefix and schema_latest resolve schemas using the configured Schema
Registry context; if they do, document that lookup behavior alongside the
existing context and qualified-subject explanation.

[[resolve-schemas-within-a-context]]
== Resolve schemas within a Schema Registry context

If you use xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry contexts] to isolate schemas (for example, by environment or tenant), set the `redpanda.schema.registry.context` topic property to bind the topic to that context. Redpanda then resolves the schemas referenced by records in the topic against the configured context instead of the default context (`.`). Depending on the topic's Iceberg mode, Redpanda looks up either the schema ID embedded in each record (`value_schema_id_prefix` mode) or the latest schema for a subject (`value_schema_latest` mode) within that context.

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.

Suggested change
If you use xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry contexts] to isolate schemas (for example, by environment or tenant), set the `redpanda.schema.registry.context` topic property to bind the topic to that context. Redpanda then resolves the schemas referenced by records in the topic against the configured context instead of the default context (`.`). Depending on the topic's Iceberg mode, Redpanda looks up either the schema ID embedded in each record (`value_schema_id_prefix` mode) or the latest schema for a subject (`value_schema_latest` mode) within that context.
If you use xref:manage:schema-reg/schema-reg-contexts.adoc[Schema Registry contexts] to isolate schemas (for example, by environment or tenant), set the `redpanda.schema.registry.context` topic property to bind the topic to that context. Redpanda then resolves the schemas referenced by records in the topic against the configured context instead of the default context (`.`). This applies to all schema-decoding modes, for both keys and values: the `value_schema_id_prefix` and `value_schema_latest` shorthand modes, and any `key` or `value` section that uses `mode=schema_id_prefix` or `mode=schema_latest`.

@wdberkeley does this change look good per this bot feedback?

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.

1 participant