Skip to content

Commit 9302d85

Browse files
emaxerrnoclaude
andcommitted
Add Oxla SQL Reference documentation as beta component
Integrate Oxla SQL documentation into the main Redpanda docs repository as a new Antora component with beta status, following the same pattern as Redpanda Connect integration. ## New Content - **Oxla SQL Reference** (202 pages): Complete SQL reference covering statements, clauses, data types, functions, mutations, and system catalogs - **Security** (6 pages): Access control, roles, privileges, ownership, and SSL configuration - **Troubleshooting** (2 pages): Error handling and degraded state management - **Total**: 210 AsciiDoc pages with comprehensive navigation ## Component Structure - `oxla/antora.yml`: Component configuration with beta badging - `oxla/modules/oxla/`: Landing page and home content - `oxla/modules/oxla-reference/`: SQL reference documentation - `oxla/modules/oxla-manage/`: Security and access control - `oxla/modules/oxla-troubleshoot/`: Troubleshooting guides ## Key Features - PostgreSQL-compatible SQL reference with detailed function documentation - Role-based access control and privilege management - System catalog documentation - 143 images migrated and optimized for Antora - Beta status clearly marked with badges and banners ## Configuration Changes - `local-antora-playbook.yml`: Added oxla content source with separate start_path to enable component recognition - Component ordered after Redpanda Connect in navigation (order: 5) - Beta badge applied via `page-beta` attribute across all Oxla pages ## Quality Assurance - Zero build warnings or errors specific to Oxla content - All pages listed in navigation (no orphaned pages) - Proper AsciiDoc syntax throughout - Cross-references validated and working - All images render correctly This integration enables deprecation of the standalone oxla-docs repository. Future Oxla documentation updates will be made directly to this repository. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
1 parent 2f697a0 commit 9302d85

375 files changed

Lines changed: 27677 additions & 12 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

local-antora-playbook.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ urls:
1010
latest_version_segment: 'current'
1111
output:
1212
clean: true
13-
runtime:
14-
log:
15-
failure_level: error
13+
1614
content:
1715
sources:
1816
- url: .
1917
branches: HEAD
18+
- url: .
19+
branches: HEAD
20+
start_path: oxla
2021
- url: https://github.com/redpanda-data/docs
2122
branches: [v/*, shared, site-search,'!v-end-of-life/*']
2223
- url: https://github.com/redpanda-data/cloud-docs

modules/manage/pages/schema-reg/schema-id-validation.adoc

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,17 @@ To use schema ID validation:
3737

3838
ifndef::env-cloud[]
3939
By default, server-side schema ID validation is disabled in Redpanda. To enable schema ID validation, change the xref:reference:cluster-properties.adoc#enable_schema_id_validation[`enable_schema_id_validation`] cluster property from its default value of `none` to either `redpanda` or `compat`:
40+
endif::[]
41+
42+
ifdef::env-cloud[]
43+
By default, server-side schema ID validation is disabled in Redpanda. To enable schema ID validation, change the xref:reference:properties/cluster-properties.adoc#enable_schema_id_validation[`enable_schema_id_validation`] cluster property from its default value of `none` to either `redpanda` or `compat`:
44+
endif::[]
4045

4146
* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
4247
* `redpanda`: Schema validation is enabled. Only Redpanda topic properties are accepted.
4348
* `compat`: Schema validation is enabled. Both Redpanda and compatible topic properties are accepted.
4449

50+
ifndef::env-cloud[]
4551
For example, use `rpk` to set the value of `enable_schema_id_validation` to `redpanda` through the Admin API:
4652

4753
[,bash]
@@ -51,13 +57,7 @@ rpk cluster config set enable_schema_id_validation redpanda -X admin.hosts=<admi
5157
endif::[]
5258

5359
ifdef::env-cloud[]
54-
To enable schema ID validation, set the `enable_schema_id_validation` cluster property to either `redpanda` or `compat`:
55-
56-
* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
57-
* `redpanda`: Schema validation is enabled. Only Redpanda topic properties are accepted.
58-
* `compat`: Schema validation is enabled. Both Redpanda and compatible topic properties are accepted.
59-
60-
See xref:manage:cluster-maintenance/config-cluster.adoc[]
60+
See xref:manage:cluster-maintenance/config-cluster.adoc[].
6161
endif::[]
6262

6363
=== Set subject name strategy per topic
@@ -87,6 +87,7 @@ When <<enable-schema-id-validation,schema ID validation is enabled>>, Redpanda u
8787

8888
To customize the subject name strategy per topic, set the following client topic properties:
8989

90+
ifndef::env-cloud[]
9091
* Set xref:reference:properties/topic-properties.adoc#redpandakeyschemavalidation[`redpanda.key.schema.id.validation`] to `true` to enable key schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandakeysubjectnamestrategy[`redpanda.key.subject.name.strategy`] to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`).
9192
* Set xref:reference:properties/topic-properties.adoc#redpandavalueschemavalidation[`redpanda.value.schema.id.validation`] to `true` to enable value schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandavaluesubjectnamestrategy[`redpanda.value.subject.name.strategy`] to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`).
9293

@@ -109,11 +110,38 @@ The `redpanda.` properties have corresponding `confluent.` properties.
109110
| xref:reference:properties/topic-properties.adoc#redpandavaluesubjectnamestrategy[`redpanda.value.subject.name.strategy`]
110111
| xref:reference:properties/topic-properties.adoc#confluentvaluesubjectnamestrategy[`confluent.value.subject.name.strategy`]
111112
|===
113+
====
114+
endif::[]
115+
116+
ifdef::env-cloud[]
117+
* Set `redpanda.key.schema.id.validation` to `true` to enable key schema ID validation for the topic, and set `redpanda.key.subject.name.strategy` to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`).
118+
* Set `redpanda.value.schema.id.validation` to `true` to enable value schema ID validation for the topic, and set `redpanda.value.subject.name.strategy` to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`).
119+
120+
[NOTE]
121+
====
122+
The `redpanda.` properties have corresponding `confluent.` properties.
123+
124+
|===
125+
| Redpanda property | Confluent property
126+
127+
| `redpanda.key.schema.id.validation`
128+
| `confluent.key.schema.validation`
129+
130+
| `redpanda.key.subject.name.strategy`
131+
| `confluent.key.subject.name.strategy`
132+
133+
| `redpanda.value.schema.id.validation`
134+
| `confluent.value.schema.validation`
135+
136+
| `redpanda.value.subject.name.strategy`
137+
| `confluent.value.subject.name.strategy`
138+
|===
139+
====
140+
endif::[]
112141

113142
The `redpanda.*` and `confluent.*` properties are compatible. Either or both can be set simultaneously.
114143

115144
If `subject.name.strategy` is prefixed with `confluent.`, the available subject name strategies must be prefixed with `io.confluent.kafka.serializers.subject.`. For example, `io.confluent.kafka.serializers.subject.TopicNameStrategy`.
116-
====
117145

118146
NOTE: To support schema ID validation for compressed topics, a Redpanda broker decompresses each batch written to it so it can access the schema ID.
119147

@@ -139,4 +167,4 @@ rpk topic alter-config topic_foo \
139167
-X brokers=<broker-addr>:9092
140168
----
141169

142-
// end::single-source[]
170+
// end::single-source[]

modules/reference/pages/glossary.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
Terms are organized into the following categories:
44

5+
- <<Agentic Data Plane>>
56
- <<Redpanda Cloud>>
67
- <<Redpanda core>>
78
- <<Redpanda features>>

modules/reference/partials/properties/cluster-properties.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5011,10 +5011,13 @@ endif::[]
50115011
|===
50125012

50135013

5014+
// tag::redpanda-cloud[]
50145015
=== enable_schema_id_validation
50155016

50165017
Controls whether Redpanda validates schema IDs in records and which topic properties are enforced.
50175018

5019+
NOTE: Enabling this property will trigger decompression of message batches for topics on which validation is configured, which may lead to a modest increase in CPU load. Redpanda recommends monitoring CPU utilization after topics are configured.
5020+
50185021
Values:
50195022

50205023
* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
@@ -5070,6 +5073,7 @@ endif::[]
50705073

50715074
|===
50725075

5076+
// end::redpanda-cloud[]
50735077

50745078
// tag::redpanda-cloud[]
50755079
=== enable_shadow_linking

oxla/antora.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: oxla
2+
title: Oxla SQL
3+
version: beta
4+
start_page: oxla:index.adoc
5+
nav:
6+
- modules/oxla/nav.adoc
7+
- modules/oxla-reference/nav.adoc
8+
- modules/oxla-manage/nav.adoc
9+
- modules/oxla-troubleshoot/nav.adoc
10+
asciidoc:
11+
attributes:
12+
page-header-data:
13+
order: 5 # Position in main nav (after Upgrade)
14+
color: '#4F46E5' # Oxla brand color (indigo)
15+
beta: true # Beta badge flag
16+
page-component-name: oxla
17+
page-component-title: 'Oxla SQL (Beta)'
18+
# Oxla-specific attributes
19+
oxla-version: 'beta-1.0'
20+
page-beta: '' # Enables beta badge on all pages
21+
# Home page data for Oxla landing page
22+
page-home-intro: 'Oxla is a PostgreSQL-compatible analytical database that provides high-performance SQL query processing. This documentation covers Oxla SQL dialect, including statements, functions, data types, and system configuration.'
23+
page-home-intro-learn-more: oxla-reference:overview.adoc
24+
page-home-primary-row-title: 'SQL Reference'
25+
page-home-primary-row:
26+
- title: 'SQL Statements'
27+
description: 'Complete reference for all SQL statements supported by Oxla.'
28+
url: 'oxla-reference:sql-statements/overview.adoc'
29+
link-text: 'View statements'
30+
- title: 'SQL Functions'
31+
description: 'Browse all built-in SQL functions and operators.'
32+
url: 'oxla-reference:sql-functions/overview.adoc'
33+
link-text: 'View functions'
34+
- title: 'Data Types'
35+
description: 'Explore supported SQL data types and their usage.'
36+
url: 'oxla-reference:sql-data-types/overview.adoc'
37+
link-text: 'View types'
38+
page-home-secondary-row-title: 'Security & Management'
39+
page-home-secondary-row:
40+
- title: 'Access Control'
41+
description: 'Configure roles, privileges, and permissions.'
42+
url: 'oxla-manage:access-control.adoc'
43+
link-text: 'Learn more'
44+
- title: 'Roles'
45+
description: 'Manage database roles and permissions.'
46+
url: 'oxla-manage:roles.adoc'
47+
link-text: 'Learn more'
48+
- title: 'Troubleshooting'
49+
description: 'Error handling and degraded state management.'
50+
url: 'oxla-troubleshoot:error-handling.adoc'
51+
link-text: 'Learn more'

oxla/modules/oxla-manage/nav.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.Security
2+
* xref:oxla-manage:access-control.adoc[Access Control]
3+
* xref:oxla-manage:roles.adoc[Roles]
4+
* xref:oxla-manage:ownership.adoc[Ownership]
5+
* xref:oxla-manage:privileges.adoc[Privileges]
6+
* xref:oxla-manage:operation-permission-rules.adoc[Permission Rules for Operations]
7+
* xref:oxla-manage:ssl-configuration.adoc[SSL Configuration]
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
= Access Control
2+
3+
4+
## Overview
5+
6+
Oxla implements role-based access control (RBAC) features, including roles, privileges
7+
and ownership. These features function similarly to those found in other leading database systems,
8+
providing a familiar access control model for users and administrators.
9+
10+
## Enabling Access Control
11+
12+
Access control is enabled by default on new Oxla installations. You can disable access control through the configuration file if needed.
13+
For detailed instructions on configuring access control, refer to the Oxla
14+
<a href="/configuration-deployment/configuration/oxla-configuration-file" target="_blank">Configuration File</a> documentation.
15+
16+
The access control (AC) behavior is as follows:
17+
18+
* If the access control flag is explicitly set in the configuration file, that setting is always followed
19+
* If the flag is not explicitly set in the configuration:
20+
* When Oxla Home is empty, AC will be **enabled** by default
21+
* When Oxla Home is non-empty, AC will be **enabled** only if it was previously enabled
22+
23+
[NOTE]
24+
====
25+
For backward compatibility, old Oxla versions did not have access control (AC).
26+
If you use a new Oxla release with an Oxla Home created by these old versions, AC will be **disabled** by default.
27+
However, if the Oxla Home comes from an older where AC was likely enabled, then AC will be **enabled** by default.
28+
This behavior helps maintain security settings appropriate to the Oxla Home’s history.
29+
====
30+
31+
32+
## Default Superuser
33+
34+
Oxla always includes a default superuser account named `oxla` with the initial password `oxla`.
35+
36+
* During the first startup, you can set a custom password for the default superuser using the `access_control.initial_password` parameter in the configuration file
37+
* After setting the password, you can remove this parameter from the configuration
38+
* You can also change the password later using the <a href="/security/roles#changing-password" target="_blank">ALTER ROLE</a> query
39+
40+
[TIP]
41+
====
42+
For security reasons, it is highly recommended to change the default superuser password immediately after installation.
43+
====
44+
45+
46+
## System Catalogs Visibility
47+
48+
Users can view rows in system catalog tables only if those rows correspond to objects or reside in schemas to which the user has access.
49+
For example, in the `information_schema.tables` table, a user can see all tables for which they have any grants,
50+
as well as all tables in schemas where they have the `USAGE` privilege.
51+
52+
## Restrictions
53+
54+
* Only superusers have the `SELECT` privilege on internal system tables
55+
* Privileges on internal system tables cannot be granted or revoked
56+
* Only superusers and database owners can create new schemas
57+
* Only superusers can create new roles
58+
* Every role is granted the `CONNECT` privilege to the default database at creation (this privilege can be revoked)
59+
* Every role is granted the `USAGE` privilege on the default `public` schema at creation (this privilege can be revoked)
60+
* Oxla does not support role membership, so **privilege inheritance** is not available
61+
62+
[NOTE]
63+
====
64+
Once access control is enabled and Oxla Home is not empty, you cannot disable access control.
65+
If you attempt to run Oxla with the access control flag in `OXLA_HOME` set to `OFF` after it was previously enabled,
66+
Oxla will enter a <a href="/troubleshooting-optimization/degraded-state-handling" target="_blank">**degraded state**</a>.
67+
====

0 commit comments

Comments
 (0)