SQL for BYOVPC (GCP) by kbatuigas · Pull Request #646 · redpanda-data/cloud-docs

kbatuigas · 2026-07-23T02:04:56Z

Description

This pull request adds comprehensive documentation for enabling Redpanda SQL on a Bring Your Own VPC (BYOVPC) cluster on GCP, including provisioning customer-managed resources, enabling/disabling the SQL engine, and verifying its status. The navigation structure is updated to include these new guides.

Documentation Additions and Navigation Updates:

Added a new guide, enable-sql-byovpc-gcp.adoc, detailing how to provision required GCP resources, enable Redpanda SQL on a BYOVPC cluster using the Cloud API, verify the engine, and disable it if needed. The guide includes prerequisites, step-by-step instructions, important caveats, and next steps.
Updated nav.adoc to add links for "Enable Redpanda SQL on BYOVPC" and specifically for GCP, improving discoverability and organization of SQL enablement documentation.

Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline: 27 July

Page previews

https://deploy-preview-646--rp-cloud.netlify.app/cloud-data-platform/sql/get-started/enable-sql-byovpc-gcp/

Checks

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

netlify · 2026-07-23T02:05:02Z

✅ Deploy Preview for rp-cloud ready!

Name	Link
🔨 Latest commit	`65f5162`
🔍 Latest deploy log	https://app.netlify.com/projects/rp-cloud/deploys/6a6b8c0eb6acac00075636f0
😎 Deploy Preview	https://deploy-preview-646--rp-cloud.netlify.app
📱 Preview on mobile	Toggle 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 · 2026-07-23T02:05:05Z

📝 Walkthrough

Walkthrough

The SQL navigation now separates BYOC and BYOVPC enablement and adds a GCP-specific entry. The BYOC guide reflects AWS and GCP availability. A new page documents provisioning SQL-specific GCP resources, enabling SQL on new or existing BYOVPC clusters through Terraform or the Cloud API, polling operations, verifying readiness, and disabling SQL. It also describes catalog behavior, retained GCP resources, and next steps.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Sequence Diagram(s)

sequenceDiagram
  participant Operator
  participant BYOVPC Terraform module
  participant Cloud API
  participant BYOVPC cluster
  Operator->>BYOVPC Terraform module: Enable SQL resource provisioning
  BYOVPC Terraform module-->>Operator: Return SQL resource outputs
  Operator->>Cloud API: Create or patch BYOVPC cluster with SQL configuration
  Cloud API->>BYOVPC cluster: Start SQL deployment operation
  BYOVPC cluster-->>Cloud API: Complete deployment operation
  Operator->>BYOVPC cluster: Verify SQL readiness or connect with psql

Possibly related PRs

redpanda-data/cloud-docs#617: Adds related Terraform documentation for the rpsql configuration used by BYOVPC SQL enablement.
redpanda-data/cloud-docs#636: Expands related BYOC and GCP SQL enablement guidance.

Suggested reviewers: ncole, mattschumpert, rpdevmp, feediver1

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately names the main change: SQL support for BYOVPC on GCP.
Description check	✅ Passed	The description follows the template and covers the change, preview, deadline, and checks; the issue number is still a placeholder.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch DOC-2356-document-feature-byovpc-for-oxla-gcp

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

david-yu

Thanks for the PR. I would smile the see if it's possible to also provide examples via terraform as well that shows how to provide those new permissions required by BYOVPC and SQL

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

modules/sql/pages/get-started/enable-sql-byovpc-gcp.adoc (1)
315-315: 🩺 Stability & Availability | 🔵 Trivial | ⚡ Quick win

Document the required ordering before deleting SQL resources.

The disable operation is asynchronous, while the guide states that these resources are immutable while SQL is enabled. Tell users to wait until disabling completes before setting enable_redpanda_sql = false and applying Terraform; otherwise the apply may attempt to remove resources still referenced by the cluster.
🤖 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/sql/pages/get-started/enable-sql-byovpc-gcp.adoc` at line 315, Update
the SQL BYOVPC cleanup instructions to state that users must wait for the
asynchronous SQL disable operation to complete before setting
enable_redpanda_sql = false and running terraform apply. Preserve the existing
options for reusing resources or destroying all BYOVPC resources, while making
the ordering explicit to avoid removing resources still referenced by the
cluster.

🤖 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/sql/pages/get-started/deploy-sql-cluster.adoc`:
- Line 17: Update the introductory NOTE in the deploy SQL cluster procedure so
its advertised provider scope matches the steps below: either add the
corresponding GCP/provider-neutral flow to the procedure, or restrict the NOTE
to AWS and retain the existing BYOVPC GCP references.

---

Nitpick comments:
In `@modules/sql/pages/get-started/enable-sql-byovpc-gcp.adoc`:
- Line 315: Update the SQL BYOVPC cleanup instructions to state that users must
wait for the asynchronous SQL disable operation to complete before setting
enable_redpanda_sql = false and running terraform apply. Preserve the existing
options for reusing resources or destroying all BYOVPC resources, while making
the ordering explicit to avoid removing resources still referenced by the
cluster.

🪄 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: 26a2ac36-974c-45d0-ba5b-ae32e29acbf3

📥 Commits

Reviewing files that changed from the base of the PR and between 823afa1 and 65f5162.

📒 Files selected for processing (3)

modules/ROOT/nav.adoc
modules/sql/pages/get-started/deploy-sql-cluster.adoc
modules/sql/pages/get-started/enable-sql-byovpc-gcp.adoc

coderabbitai · 2026-07-30T18:57:37Z

 * [ ] {learning-objective-3}

-NOTE: Redpanda SQL is currently available only on BYOC clusters running on AWS.
+NOTE: Redpanda SQL is available for BYOC clusters on AWS and GCP. For BYOVPC clusters, see xref:sql:get-started/enable-sql-byovpc-aws.adoc[AWS] or xref:sql:get-started/enable-sql-byovpc-gcp.adoc[GCP].


🎯 Functional Correctness | 🟠 Major | 🏗️ Heavy lift

Keep the advertised GCP support consistent with the procedure.

Line 17 now includes GCP, but the new-cluster console/API flow below is AWS-only (on AWS and CLOUD_PROVIDER_AWS). Add the GCP/provider-neutral flow, or scope this notice to AWS so GCP users are not sent into an incomplete procedure.

🤖 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/sql/pages/get-started/deploy-sql-cluster.adoc` at line 17, Update the introductory NOTE in the deploy SQL cluster procedure so its advertised provider scope matches the steps below: either add the corresponding GCP/provider-neutral flow to the procedure, or restrict the NOTE to AWS and retain the existing BYOVPC GCP references.

Intermediate merge form for landing after #620 (AWS BYOVPC page exists) and before #646 adds the GCP BYOVPC link. Uses the scope framing and corrected "AWS and GCP" BYOC scope. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

kbatuigas added 3 commits July 20, 2026 17:27

Draft SQL BYOVPC on GCP

fa4831d

Update draft with correct GCP BYOVPC customer workflow

0f86bfd

Update TODOs

957be96

kbatuigas requested review from david-yu, mattschumpert, ncole and rpdevmp July 23, 2026 02:11

david-yu approved these changes Jul 24, 2026

View reviewed changes

kbatuigas added 3 commits July 29, 2026 23:13

TF provider updates for SQL on GCP

2ad26c9

Review pass

fd93f01

Consistency across the BYOVPC docs

65f5162

kbatuigas marked this pull request as ready for review July 30, 2026 18:48

kbatuigas requested a review from a team as a code owner July 30, 2026 18:48

coderabbitai Bot reviewed Jul 30, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

SQL for BYOVPC (GCP) - #646

SQL for BYOVPC (GCP)#646
kbatuigas wants to merge 6 commits into
mainfrom
DOC-2356-document-feature-byovpc-for-oxla-gcp

kbatuigas commented Jul 23, 2026 •

edited

Loading

Uh oh!

netlify Bot commented Jul 23, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading

Walkthrough

Sequence Diagram(s)

Uh oh!

david-yu left a comment

Uh oh!

coderabbitai Bot left a comment

Uh oh!

coderabbitai Bot Jul 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

kbatuigas commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Page previews

Checks

Uh oh!

netlify Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for rp-cloud ready!

Uh oh!

coderabbitai Bot commented Jul 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Sequence Diagram(s)

Uh oh!

david-yu left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Jul 30, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kbatuigas commented Jul 23, 2026 •

edited

Loading

netlify Bot commented Jul 23, 2026 •

edited

Loading

coderabbitai Bot commented Jul 23, 2026 •

edited

Loading