Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
a851d42
DOC-1196 Draft
Feediver1 Jul 22, 2025
4408804
DOC-1196 acl update
Feediver1 Jul 22, 2025
c02508c
draft
Feediver1 Jul 22, 2025
693dda2
DOC-1196
Feediver1 Jul 22, 2025
7fa3543
adding to draft
Feediver1 Jul 24, 2025
be8b14d
drafting
Feediver1 Jul 24, 2025
b3718bc
revisions
Feediver1 Jul 24, 2025
537d113
wip
Feediver1 Jul 25, 2025
2a85959
wip
Feediver1 Jul 25, 2025
91696af
fixed order of cmd name
Feediver1 Jul 25, 2025
b74a7ac
fixed link
Feediver1 Jul 25, 2025
fa83219
wip
Feediver1 Jul 25, 2025
6233c7c
edits
Feediver1 Jul 25, 2025
fc22650
what's new
Feediver1 Jul 25, 2025
c30e1e9
Add create ACL to SR API usage doc
kbatuigas Jul 23, 2025
1588049
Enclose license partial with admonition
kbatuigas Jul 28, 2025
8e89d96
PR review feedback
Feediver1 Jul 28, 2025
1fcec6d
Apply suggestions from code review
Feediver1 Jul 28, 2025
edf82b2
merge conflicts
Feediver1 Jul 28, 2025
ab51aaa
tag fix
Feediver1 Jul 29, 2025
cd029f0
nit
Feediver1 Jul 29, 2025
175be22
wip
Feediver1 Jul 29, 2025
5fc4e0a
Update modules/manage/pages/schema-reg/schema-reg-api.adoc
kbatuigas Jul 29, 2025
7fb2fa8
format change
Feediver1 Jul 29, 2025
84a70e5
review updates
Feediver1 Jul 30, 2025
a93c88a
review comments
Feediver1 Jul 30, 2025
ca7c6ba
comments
Feediver1 Jul 30, 2025
03924bf
missed one
Feediver1 Jul 30, 2025
1a9396f
Merge branch 'beta' into DOC-1196
Feediver1 Jul 30, 2025
f5516b7
resolve case issue
Feediver1 Jul 30, 2025
a9efe84
case fix
Feediver1 Jul 30, 2025
1be715f
Apply edit per suggestion
kbatuigas Jul 30, 2025
fdbeb93
Update modules/manage/pages/schema-reg/schema-reg-authorization.adoc
Feediver1 Jul 30, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
**** xref:manage:schema-reg/schema-reg-api.adoc[API]
**** xref:console:ui/schema-reg.adoc[Redpanda Console]
**** xref:manage:kubernetes/k-schema-controller.adoc[Kubernetes]
*** xref:manage:schema-reg/schema-reg-authorization.adoc[Schema Registry Authorization]
*** xref:manage:schema-reg/schema-id-validation.adoc[]
*** xref:console:ui/schema-reg.adoc[Manage in Redpanda Console]
** xref:manage:console/index.adoc[Redpanda Console]
Expand Down
4 changes: 4 additions & 0 deletions modules/get-started/pages/licensing/overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,10 @@ The following table lists the enterprise features for Redpanda and how Redpanda
| Manages user roles and permissions within the cluster.
| Roles and ACLs associated with roles cannot be created or modified. Role deletion is allowed.

| xref:manage:schema-reg/schema-reg-authorization.adoc[Schema Registry Authorization]
| Manages ACLs for Redpanda Schema Registry resources within the cluster.
| You can no longer enable `schema_registry_enable_authorization`, nor can you create or modify schema ACLs.

| xref:manage:schema-reg/schema-id-validation.adoc[Server-Side Schema ID Validation]
| Validates schema IDs server-side to ensure schema compatibility. With schema ID validation, records associated with unregistered schemas are detected and dropped by a broker rather than a consumer.
| Topics with schema validation settings cannot be created or modified.
Expand Down
9 changes: 8 additions & 1 deletion modules/get-started/pages/release-notes/redpanda.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ Redpanda now supports the following Kafka APIs for managing SASL user credential

See also: xref:manage:security/authentication.adoc#sasl[Configure Authentication] and xref:manage:security/authorization/acl.adoc[]

== Schema Registry Authorization

You can now use the Enterprise-licensed feature xref:manage:schema-reg-authorization.adoc[Schema Registry Authorization] to control access to Schema Registry subjects and operations using either `rpk` or the xref:api:ROOT:schema-registry-api.adoc#get-/security/acls[Redpanda Schema Registry API] endpoints. Schema Registry Authorization offers more granular control over who can do what with your Redpanda Schema Registry resources. ACLs used for Schema Registry access also support RBAC roles.

== Retrieve serialized Protobuf schemas with Schema Registry API

Starting in version 25.2, the Schema Registry API supports retrieving serialized schemas (Protobuf only) using the `format=serialized` query parameter for the following endpoints:
Expand Down Expand Up @@ -53,13 +57,16 @@ HTTP Proxy previously used automatically-generated ephemeral credentials to auth
If you need to maintain the current HTTP Proxy functionality while transitioning to authenticated clients, configure the following HTTP Proxy client properties in your `redpanda.yaml` configuration:

- xref:reference:properties/broker-properties.adoc#scram_username[`scram_username`]: Username for SASL/SCRAM authentication
- xref:reference:properties/broker-properties.adoc#scram_password[`scram_password`]: Password for SASL/SCRAM authentication
- xref:reference:properties/broker-properties.adoc#scram_password[`scram_password`]: Password for SASL/SCRAM authentication
- xref:reference:properties/broker-properties.adoc#sasl_mechanism[`sasl_mechanism`]: SASL mechanism (typically `SCRAM-SHA-256` or `SCRAM-SHA-512`)


== Cluster properties

The following cluster properties are new in this version:

- xref:reference:properties/cluster-properties.adoc#schema_registry_enable_authorization[`schema_registry_enable_authorization`]

=== Iceberg integration

* config_ref:iceberg_rest_catalog_base_location,true,properties/cluster-properties[`iceberg_rest_catalog_base_location`]: Specifies the base location for the Iceberg REST catalog. Required for AWS Glue Data Catalog.
45 changes: 44 additions & 1 deletion modules/manage/pages/schema-reg/schema-reg-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,49 @@ def pretty(text):
base_uri = "http://localhost:8081"
----

== Manage Schema Registry ACLs

ifndef::env-cloud[]
[NOTE]
====
include::shared:partial$enterprise-license.adoc[]
====
endif::[]

You can use ACLs to control access to Schema Registry resources. You can define fine-grained access on a global level, for example, to allow a principal to read all schemas, or on a per-subject basis, for example, to read and modify only the schemas of a specific subject.

See xref:manage:schema-reg/schema-reg-authorization.adoc[] for more details on Schema Registry Authorization.

For example, to xref:api:ROOT:pandaproxy-schema-registry.adoc#post-/security/acls[create ACLs] that allow users with the `admin` role read-only access to all registered schemas, run:

[,bash]
----
curl -X POST "http://localhost:8081/security/acls" \
-H "Content-Type: application/json" \
-d '[
{
"principal": "RedpandaRole:admin",
"resource": "*",
"resource_type": "REGISTRY",
"pattern_type": "LITERAL",
"host": "*",
"operation": "DESCRIBE_CONFIGS",
"permission": "ALLOW"
},
{
"principal": "RedpandaRole:admin",
"resource": "*",
"resource_type": "SUBJECT",
"pattern_type": "LITERAL",
"host": "*",
"operation": "READ",
"permission": "ALLOW"
}
]'
----

This creates two ACLs: one for registry-level read operations (such as reading global configuration) and another for subject-level read operations (such as reading schemas).

== Query supported schema formats

To get the supported data serialization formats in the Schema Registry, make a GET request to the `/schemas/types` endpoint:
Expand Down Expand Up @@ -935,7 +978,7 @@ Curl::

== Use READONLY mode for disaster recovery

The `/mode` endpoint allows you to put Schema Registry in read-only or read-write mode. A read-only Schema Registry does not accept direct writes. An active production cluster can replicate schemas to a read-only Schema Registry to keep it in sync, for example using Redpanda's https://github.com/redpanda-data/schema-migration/[Schema Migration tool^]. Users in the disaster recovery (DR) site cannot update schemas directly, so the DR cluster has an exact replica of the schemas in production. In a failover due to a disaster or outage, you can set Schema Registry to read-write mode, taking over for the failed cluster and ensuring availability.
The `/mode` endpoint allows you to put Schema Registry in read-only or read-write mode. A read-only Schema Registry does not accept direct writes. An active production cluster can replicate schemas to a read-only Schema Registry to keep it in sync, for example using Redpanda's https://github.com/redpanda-data/schema-migration/[Schema Migration tool^]. Users in the disaster recovery (DR) site cannot update schemas directly, so the DR cluster has an exact replica of the schemas in production. In a failover due to a disaster or outage, you can set Schema Registry to read-write mode, taking over for the failed cluster and ensuring availability.

If authentication is enabled on Schema Registry, only superusers can change global and subject-level modes.

Expand Down
Loading