You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/manage/pages/schema-reg/schema-reg-contexts.adoc
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@
15
15
// in ifdef::env-cloud[] ... endif::[] blocks. Self-managed-only content
16
16
// is wrapped in ifndef::env-cloud[] ... endif::[] blocks.
17
17
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.
19
19
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.
21
21
22
22
== When to use contexts
23
23
@@ -38,7 +38,7 @@ Before using Schema Registry contexts, ensure that:
38
38
ifndef::env-cloud[]
39
39
[NOTE]
40
40
====
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.
42
42
====
43
43
endif::env-cloud[]
44
44
+
@@ -49,27 +49,27 @@ On Serverless, contexts are enabled by default. On BYOC and Dedicated clusters,
49
49
====
50
50
endif::env-cloud[]
51
51
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>>.
53
53
54
54
== Limitations
55
55
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.
57
57
* *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.
58
58
* *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.
60
60
* *WASM integration*: Context-aware schema IDs are not yet surfaced in WASM data transforms.
61
61
* *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>>.
62
62
63
63
ifndef::env-cloud[]
64
64
[NOTE]
65
65
====
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.
67
67
====
68
68
endif::env-cloud[]
69
69
70
70
== How Schema Registry contexts work
71
71
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.
73
73
74
74
Contexts are referenced in the API using a *qualified subject* syntax:
75
75
@@ -121,7 +121,7 @@ Wherever the Schema Registry API accepts a subject—in path parameters, query p
121
121
| `:<context>:<subject>` | Subject `<subject>` in context `<context>`.
122
122
| `:.production:user-events-value` | Subject `user-events-value` in context `.production`.
123
123
| `:.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.
125
125
|===
126
126
127
127
=== Register a schema in a context
@@ -140,7 +140,7 @@ The schema ID returned is unique within the `.production` context and independen
140
140
141
141
=== List contexts
142
142
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:
0 commit comments