Add SQL Engine (Oxla) workshop documentation for BYOC #500
Conversation
Add comprehensive workshop guide for provisioning and using Redpanda SQL Engine (Oxla) with BYOC clusters. The workshop covers: - Overview of SQL Engine architecture and capabilities - Limitations and prerequisites - BYOC cluster provisioning with SQL Engine - User management and authentication - Creating tables from Redpanda topics with Schema Registry integration - Installing and using psql client - Scaling operations via Fleet Management API - Cluster deletion procedures Organized for a 2-3 hour hands-on workshop with practical examples. Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the
📝 WalkthroughWalkthroughThis change adds a new documentation page for the Redpanda SQL Engine Workshop and updates the navigation structure to include it. The navigation file adds a single entry linking to the new workshop documentation. The workshop documentation file provides comprehensive instructional content covering the SQL Engine's overview, BYOC deployment context, prerequisites, provisioning procedures, management operations, table and connection creation, querying capabilities, client tooling setup, scaling operations, and cleanup procedures. Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Comment |
| ---- | ||
| kubectl get secret -n redpanda-oxla oxla-superuser -o jsonpath='{.data.password}' | base64 -d | ||
| ---- | ||
|
|
There was a problem hiding this comment.
@wkozlowski-oxla Does this really work? If so, can you share the output--good to add that here so people in the workshop can see/validate the result. thx
| --cluster-ids <cluster-id> | ||
| ---- | ||
|
|
||
| To enable with external load balancer (public access): |
There was a problem hiding this comment.
| To enable with external load balancer (public access): | |
| To enable with external load balancer (public access), run: |
|
|
||
| **Authentication:** Users authenticate using username and password over PostgreSQL wire protocol. Redpanda SQL Engine supports standard PostgreSQL authentication methods including SCRAM-SHA-256. | ||
|
|
||
| For authorization, privileges control what users can do: |
There was a problem hiding this comment.
| For authorization, privileges control what users can do: | |
| **Authorization:** Privileges control what users can do: |
just for consistency with line above
| To query SQL Engine, use any PostgreSQL-compatible client. This section shows how to use `psql`, the standard PostgreSQL command-line client. | ||
|
|
||
| === Install psql | ||
|
|
There was a problem hiding this comment.
this section would feel better with tabs for macOS, Ubuntu/Debian, and RHAL/CentOS
There was a problem hiding this comment.
Agree, and if it evolves into the QS, yes. If I have time, will do.
| === Get the SQL Engine endpoint | ||
|
|
||
| Retrieve the SQL Engine connection endpoint based on your load balancer configuration. | ||
|
|
There was a problem hiding this comment.
same here: I'd turn these into tabs
|
|
||
| === Run queries | ||
|
|
||
| Once connected, you can run SQL queries: |
There was a problem hiding this comment.
| Once connected, you can run SQL queries: | |
| After you're connected, you can run SQL queries: |
| ---- | ||
|
|
||
| == Scale up or down using Data Plane APIs | ||
|
|
There was a problem hiding this comment.
This section seems internal
There was a problem hiding this comment.
@wkozlowski-oxla? Do you need this for the workshop?
| @@ -0,0 +1,514 @@ | |||
| = Redpanda SQL Engine Overview and Quickstart | |||
There was a problem hiding this comment.
will follow up w/ a name update. todo for me.
|
hey im not sure if we have this info already, but having some experience with sql databases I believe we must be blatantly obvious about Basically docs must be able to answer this connection wizard very easily (this is DBeaver client) |
|
and do we have any client recommendations if the person is using Python/Java/Go/Node? Thinking on a similar table like we have here https://docs.redpanda.com/current/develop/kafka-clients/ |
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
Co-authored-by: Michele Cyran <[email protected]>
| . In the Redpanda Cloud UI, navigate to your Oxla-enabled resource group. | ||
| . Click *Create Cluster* and select *BYOC*. | ||
| . Choose your cloud provider (AWS, GCP, or Azure) and region. | ||
| . Configure networking details (VPC/VNet, CIDR ranges). |
There was a problem hiding this comment.
If it's AWS only, should remove VNet which is Azure
It would be great if we could provide the specific values that should we used in the workshop. I understand if we don't want it in this doc as it might persist and be used after this week, but ideally workshop attendees will have this information at hand and not have to think about it.
| . Click *Create Cluster* and select *BYOC*. | ||
| . Choose your cloud provider (AWS, GCP, or Azure) and region. | ||
| . Configure networking details (VPC/VNet, CIDR ranges). | ||
| . Download the Terraform bundle generated by the wizard. |
There was a problem hiding this comment.
Is the wizard part of the Cloud / cluster creation UI?
|
|
||
| By default, Redpanda SQL Engine deploys with cluster-internal access only. To change the network exposure mode, use the Fleet Management API. | ||
|
|
||
| **To enable with internal load balancer (VPC access): |
| --cluster-ids <cluster-id> | ||
| ---- | ||
|
|
||
| After enabling an external load balancer, manually run the appropriate Terraform apply for the infrastructure module on the agent VM. |
There was a problem hiding this comment.
Can we provide for workshop attendees? Assuming that they have to run through all these steps and we're not just provisioning an Oxla-enabled cluster from the start
|
|
||
| [,sql] | ||
| ---- | ||
| CREATE ROLE data_analyst WITH LOGIN PASSWORD 'secure_password'; |
There was a problem hiding this comment.
This command as well as the rest all the way down through the Query section require that you're already connected to Oxla using a client like psql. I would move that Install SQL client section way up, after retrieve the superuser password. +1 to Paulo's comment regarding making it super clear how to connect to the Oxla db. I'm assuming we'll use psql for the workshop which should just look something like
psql -h <hostname> -U <username> -d <dbname>
Where:
- we should point out where they can find the
hostname, unless everyone in the workshop is connecting to the same one? usernamewould beoxla-superuserdbnameI believe isoxla- Then enter the password retrieved from the k8s secret, when prompted
|
|
||
| [,bash] | ||
| ---- | ||
| psql -h <oxla-endpoint> -p 5432 -U oxla_admin -d oxla |
There was a problem hiding this comment.
This is the first mention of oxla_admin, not sure if we're telling workshop attendees to create a new admin user, or oxla_superuser from the section above
| FROM customer_events c | ||
| JOIN order_events o ON c.customer_id = o.customer_id | ||
| WHERE c.timestamp > NOW() - INTERVAL '1 day'; | ||
| ---- |
There was a problem hiding this comment.
During the workshop, will we be querying tables backed by topics that are continuously being streamed to?
5 participants
Description
Deadline: EOB, Thursday, Feb 5th.
DO NOT MERGE
Adds comprehensive workshop documentation for Redpanda SQL Engine (formerly Oxla) in BYOC environments. This documentation is Cloud-specific as SQL Engine is only available in Redpanda Cloud BYOC deployments.
This workshop guide is designed for a 2-3 hour hands-on session and covers:
Structure
Added as a top-level section in the navigation under "Redpanda SQL Engine" between Deploy and Agentic AI, since this is a major BYOC-specific feature.
Files
modules/manage/pages/sql-engine/workshop.adoc- Workshop contentmodules/ROOT/nav.adoc- Navigation updatePage Preview
Once deployed, the page will be available at:
Related
This replaces PR #1566 in the docs repo, which incorrectly added this content to self-managed docs.
🤖 Generated with Claude Code