Skip to content

Commit 7566a77

Browse files
authored
Apply suggestions from code review
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
1 parent 0657a06 commit 7566a77

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

modules/manage/pages/schema-reg/schema-reg-contexts.adoc

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
// in ifdef::env-cloud[] ... endif::[] blocks. Self-managed-only content
1616
// is wrapped in ifndef::env-cloud[] ... endif::[] blocks.
1717

18-
Schema Registry contexts are namespaces that isolate schemas, subjects, and configuration from one another within a single Schema Registry instance.
18+
Schema Registry contexts provide namespaces that isolate schemas, subjects, and configuration from one another within a single Schema Registry instance, providing unique schema ID spaces per context.
1919
Each context maintains its own schema ID counter, mode, and compatibility settings.
20-
Use contexts when you need to separate schema workloads by tenant, team, or environment—without deploying multiple Schema Registry instances.
20+
Use contexts when you need to separate schema workloads by tenant, team, or environment, and avoid having to deploy multiple Schema Registry instances.
2121

2222
== When to use contexts
2323

@@ -38,7 +38,7 @@ Before using Schema Registry contexts, ensure that:
3838
ifndef::env-cloud[]
3939
[NOTE]
4040
====
41-
In 26.1, `schema_registry_enable_qualified_subjects` defaults to `false`. You must explicitly enable it for self-managed clusters or to test in a non-Serverless environment.
41+
Starting in v26.1, `schema_registry_enable_qualified_subjects` defaults to `false`. You must explicitly enable it for self-managed clusters or to test in a non-Serverless environment.
4242
====
4343
endif::env-cloud[]
4444
+
@@ -49,27 +49,27 @@ On Serverless, contexts are enabled by default. On BYOC and Dedicated clusters,
4949
====
5050
endif::env-cloud[]
5151

52-
* If you use Schema Registry ACLs, the principal interacting with a context has the appropriate permissions. See <<acl-authorization>>.
52+
* If you use Schema Registry ACLs, ensure that the principal interacting with a context has the appropriate permissions. See <<acl-authorization>>.
5353

5454
== Limitations
5555

56-
* *Console, rpk, and Kubernetes Operator*: Support for contexts in the Redpanda Console UI, `rpk` CLI, and Kubernetes Operator is not available in 26.1. Use the Schema Registry HTTP API directly. Console, rpk, and Operator support will be delivered in a subsequent release.
56+
* *Console, rpk, and Kubernetes Operator*: Do not support contexts in Redpanda v26.1. Use the Schema Registry HTTP API directly.
5757
* *Cross-context isolation*: Contexts provide organizational isolation (separate ID spaces, subject namespaces, and configuration), not full data isolation. Schemas in one context can reference schemas in another context.
5858
* *Blocking cross-context references*: There is no mechanism to prevent cross-context schema references.
59-
* *DR/RPCN syncing into specific contexts*: Syncing schemas from remote clusters directly into a named context is not yet supported.
59+
* *DR/RPCN syncing into specific contexts*: Syncing schemas from remote clusters directly into a named context is not supported.
6060
* *WASM integration*: Context-aware schema IDs are not yet surfaced in WASM data transforms.
6161
* *Breaking change on upgrade*: After enabling `schema_registry_enable_qualified_subjects`, any existing subject whose name matches the qualified subject pattern `:<context>:<subject>` (for example, `:.staging:user-value`) is reinterpreted as subject `user-value` in context `.staging` rather than as a literal subject name in the default context. See <<upgrade-considerations>>.
6262

6363
ifndef::env-cloud[]
6464
[NOTE]
6565
====
66-
No enterprise license is required to use contexts. Contexts are fully functional in the open-source Redpanda build.
66+
Schema Registry contexts does not require an enterprise license.
6767
====
6868
endif::env-cloud[]
6969

7070
== How Schema Registry contexts work
7171

72-
Redpanda Schema Registry previously maintained a flat namespace: all schemas shared a single global schema ID counter and a single set of mode and compatibility settings (with optional per-subject overrides). Contexts extend this model by introducing named namespaces. Each context has its own schema ID counter that increments independently of other contexts, plus its own mode and compatibility settings.
72+
Prior to v26.1, Redpanda Schema Registry maintained a flat namespace: all schemas shared a single global schema ID counter and a single set of mode and compatibility settings (with optional per-subject overrides). Schema Registry contexts extend this model by introducing named namespaces. Each context has its own schema ID counter that increments independently of other contexts, in addition to its own mode and compatibility settings.
7373

7474
Contexts are referenced in the API using a *qualified subject* syntax:
7575

@@ -121,7 +121,7 @@ Wherever the Schema Registry API accepts a subject—in path parameters, query p
121121
| `:<context>:<subject>` | Subject `<subject>` in context `<context>`.
122122
| `:.production:user-events-value` | Subject `user-events-value` in context `.production`.
123123
| `:.production:` | The context `.production` itself (empty subject name), used for context-level mode/config operations.
124-
| `user-events-value` | Subject `user-events-value` in the default context (unchanged behavior).
124+
| `user-events-value` | Subject `user-events-value` in the default context.
125125
|===
126126

127127
=== Register a schema in a context
@@ -140,7 +140,7 @@ The schema ID returned is unique within the `.production` context and independen
140140

141141
=== List contexts
142142

143-
To list all contexts that have been explicitly created (plus the default context), use the `GET /contexts` endpoint:
143+
To list all contexts that have been explicitly created (in addition to the default context), use the `GET /contexts` endpoint:
144144

145145
[source,bash]
146146
----
@@ -186,7 +186,7 @@ curl -s http://localhost:8081/subjects
186186

187187
=== Set context-level mode
188188

189-
Mode can be set at the context level by specifying a qualified subject with an empty subject name (`:<context>:`):
189+
You can configure mode at the context level by specifying a qualified subject with an empty subject name (`:<context>:`):
190190

191191
[source,bash]
192192
----
@@ -205,6 +205,8 @@ curl -s http://localhost:8081/mode/:.staging:
205205

206206
=== Set context-level compatibility
207207

208+
To configure context-level compatibility:
209+
208210
[source,bash]
209211
----
210212
# Set compatibility for the .production context

0 commit comments

Comments
 (0)