Skip to content

GCP BigLake support in Cloud#1731

Merged
kbatuigas merged 16 commits into
mainfrom
DOC-2221-document-feature-support-gcp-biglake-as-rest-cata
Jun 11, 2026
Merged

GCP BigLake support in Cloud#1731
kbatuigas merged 16 commits into
mainfrom
DOC-2221-document-feature-support-gcp-biglake-as-rest-cata

Conversation

@kbatuigas

@kbatuigas kbatuigas commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Description

This pull request updates the documentation to reflect the rebranding of "Google BigLake" to "Google Lakehouse for Apache Iceberg" and adds support for GCP authentication mode in the Iceberg REST catalog integration. The changes ensure terminology is consistent across documentation, clarify integration steps for both self-managed and cloud environments, and update configuration instructions for Redpanda clusters using Lakehouse as a REST catalog.

Key changes include:

Documentation Rebranding and Consistency:

  • Updated all references from "BigLake" to "Lakehouse" or "Google Lakehouse for Apache Iceberg" in navigation, guide titles, descriptions, and throughout the integration guide to align with Google's new product naming. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]

Iceberg REST Catalog Integration Enhancements:

  • Added documentation for the new gcp authentication mode in the iceberg_rest_catalog_authentication_mode property, allowing Redpanda to use GCP VM instance metadata credentials for authenticating with the Iceberg REST catalog.
  • Updated configuration examples and prerequisites for both BYOC and BYOVPC Redpanda Cloud clusters, specifying IAM roles and API requirements for Lakehouse integration. [1] [2] [3] [4]

Guide Improvements and Clarifications:

  • Clarified steps for setting up Google Cloud resources, creating service accounts, and configuring Redpanda for use with Lakehouse, including environment-specific instructions for self-managed and cloud clusters. [1] [2] [3] [4] [5] [6]
  • Updated limitations, cleanup instructions, and references to match the new Lakehouse terminology and APIs. [1] [2] [3]

Reference and Link Updates:

  • Replaced outdated links to BigLake documentation with the new Lakehouse documentation URLs. [1] [2]

Configuration Property Updates:

  • Updated configuration property descriptions and examples to reflect the new authentication mode and Lakehouse integration steps. [1] [2] [3]

These changes ensure users have up-to-date guidance for integrating Redpanda with Google Lakehouse for Apache Iceberg, supporting the latest authentication methods and aligning with Google's current product offerings.

Resolves DOC-2221
Review deadline: 10 Jun

Page previews

Cloud: Use Iceberg Topics with GCP Lakehouse
Self-Managed: Use Iceberg Topics with GCP Lakehouse

Cluster Configuration Properties

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 9, 2026 00:36
@netlify

netlify Bot commented Jun 9, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 78dda52
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a2b1a0dac87040008595bdb
😎 Deploy Preview https://deploy-preview-1731--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 Jun 9, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7995ce16-e27c-4628-8a54-78deca63008b

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

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This PR updates documentation and configuration metadata to rebrand GCP BigLake as Lakehouse throughout the Redpanda Iceberg integration guide. Changes include updating the iceberg_rest_catalog_authentication_mode property definition to add GCP authentication support, updating the navigation label, and comprehensively rewriting the main integration guide to use Lakehouse terminology. The rewrite also adds environment-conditional blocks to distinguish between cloud-managed and self-managed deployment guidance, updates prerequisites to reflect Lakehouse same-project constraints, and adjusts configuration instructions and cleanup procedures accordingly.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • redpanda-data/docs#1163: Updates iceberg_rest_catalog_authentication_mode documentation by adding oauth2 recommendations for cloud/REST catalog usage; overlaps with this PR's GCP authentication mode expansion.
  • redpanda-data/docs#1494: Adds REST-catalog setup guidance and auth-mode-related properties to the same iceberg-topics-gcp-biglake.adoc file.
  • redpanda-data/docs#1183: Adds "Configure authentication" guidance for iceberg_rest_catalog_authentication_mode property that this PR also updates.

Suggested reviewers

  • mattschumpert
  • micheleRP
  • nvartolomei
  • Feediver1
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title 'GCP BigLake support in Cloud' is partially related to the changeset. While it references GCP support, it uses outdated 'BigLake' terminology when the PR's main objective is rebranding from BigLake to 'Lakehouse.' The title doesn't accurately reflect the rebranding effort that is central to these changes. Update the title to reflect the rebranding: 'Update GCP Lakehouse documentation and add GCP authentication mode' or 'Rebrand BigLake to Lakehouse and add GCP auth mode.'
✅ Passed checks (4 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.
Description check ✅ Passed The pull request description is comprehensive and well-structured, covering all key changes including rebranding from BigLake to Lakehouse, GCP authentication mode support, configuration updates, and page previews with Netlify links.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2221-document-feature-support-gcp-biglake-as-rest-cata

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

@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 `@docs-data/property-overrides.json`:
- Line 986: Update the description string for the Iceberg catalog authentication
mode to correct the spelling mistake: replace "unconditonally" with
"unconditionally" in the description value that begins "The authentication mode
for client requests made to the Iceberg catalog..." so the property description
(the authentication mode description block) reads with the correct spelling.
🪄 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: 37b0a12a-cefb-4c4a-9a1b-628f3f333c38

📥 Commits

Reviewing files that changed from the base of the PR and between 0a37226 and 2d3d684.

📒 Files selected for processing (3)
  • docs-data/property-overrides.json
  • modules/ROOT/nav.adoc
  • modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc

Comment thread docs-data/property-overrides.json Outdated
:personas: developer, sre

ifdef::env-cloud[]
:rp_version: 26.1

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.

SME reviewer: please confirm version requirement

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.

I see no reason 25.3 wouldn't work as well but testing was focused on 26.1. Leave as is for now.

@kbatuigas kbatuigas requested a review from ncole June 9, 2026 03:04
Comment thread modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc Outdated
Comment thread modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc Outdated
Comment thread modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc Outdated
Comment thread modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc
Comment thread modules/manage/pages/iceberg/iceberg-topics-gcp-biglake.adoc
Comment thread local-antora-playbook.yml Outdated

@Feediver1 Feediver1 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.

Automated docs-standards review

Overall: Clean, well-executed rebrand (BigLake → Google Lakehouse for Apache Iceberg) plus the new gcp auth mode and Cloud GA support. SME review (ncole) is approved and all inline comments are addressed. One merge blocker remains, plus a few verify-before-merge items.

Critical (must fix before merge)

  1. local-antora-playbook.yml:21 — cloud-docs source points at a feature branch:
    - url: https://github.com/redpanda-data/cloud-docs
      branches: 'DOC-2221-biglake-cloud-docs'   # was: main
    Revert to branches: main before merge (already flagged with a "commit before merge" suggestion). Merging as-is breaks local/preview builds for everyone.

Suggestions / verify before merge

  1. Self-managed config consistency — The SME's "we aren't using oauth2 on GCP yet" feedback was addressed by removing iceberg_rest_catalog_oauth2_server_uri from the Cloud rpk block. Confirm the self-managed config example also omits oauth2_server_uri and uses authentication_mode=gcp, so the two paths on the same page don't contradict each other.
  2. Iceberg modes xref — The link was changed to xref:manage:iceberg/specify-iceberg-schema.adoc[] while the prose still says "for more details on Iceberg modes." Verify that target exists and is the right page for modes (vs. schema).
  3. Generated partialmodules/reference/partials/properties/cluster-properties.adoc was edited directly. Source of truth is docs-data/property-overrides.json (also edited, consistently). Confirm the partial was regenerated from the override rather than hand-synced, so a future regen doesn't clobber it.
  4. Link domain consistency — Mixed cloud.google.com/biglake/... and docs.cloud.google.com/lakehouse/... links. Worth a consistency pass now that the page is otherwise on the new Lakehouse paths.
  5. Prerequisites rendering — The restructured list nests a cloud-only ** bullet between the GCP-project * bullet and its + continuation paragraph. Quick rendered-preview check that the "If you do not have permissions…" paragraph attaches to the right list item in both builds.
  6. PR title — Still reads "GCP BigLake support in Cloud"; consider updating to "Lakehouse" to match the content.

Impact on other files (limited — repo not checked out locally)

  • use-iceberg-catalogs.adoc and nav.adoc — already updated in this PR. ✅
  • What's New — Cloud support moved Beta → Supported and a new gcp auth mode was added. Verify whether whats-new-cloud.adoc needs a corresponding entry (none in this PR).
  • Filename unchanged, so existing xrefs to the page should still resolve.

CodeRabbit

  • The one actionable item (unconditonallyunconditionally typo) is already fixed in this PR. No outstanding bot findings.

What works well

  • Learning objectives: 3 max, action verbs, checkbox format, defined inside the single-source tag so they carry to cloud-docs.
  • Property description updated consistently in both the override JSON and the generated partial.
  • Disciplined block-level ifdef/ifndef::env-cloud[] single-sourcing; BYOC vs BYOVPC paths clearly separated; the leftover // TODO about iceberg_dlq_table_suffix was properly resolved, not shipped.
  • All SME inline comments (version requirement, outdated gcloud link, alpha biglake command, oauth2 removal) addressed.

🤖 Generated with Claude Code

@Feediver1

Copy link
Copy Markdown
Contributor

@kbatuigas Looks like you already fixed the critical fix, so suggestions are up to you.

@david-yu

Copy link
Copy Markdown
Contributor

Looks good assuming we call out which clusters are supported and when users need to run rpk byoc apply to existing cluster to get new functionality.

@david-yu david-yu self-requested a review June 11, 2026 18:58
@kbatuigas kbatuigas merged commit c716a5a into main Jun 11, 2026
7 checks passed
@kbatuigas kbatuigas deleted the DOC-2221-document-feature-support-gcp-biglake-as-rest-cata branch June 11, 2026 20:31
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.

4 participants