Schema Registry
Browse and evolve the schemas of your topics, check compatibility before you register, and read or write schema-aware messages.
Connect a registry
Add a Schema Registry to a Kafka cluster (cluster ADMIN) with:
- its URL, or several URLs separated by commas;
- optional basic authentication (username and password, stored encrypted);
- optionally, a registry reached through Kubernetes;
- whether it is the default registry of the cluster.
Registries of Confluent Cloud clusters are imported with their API key, see Confluent Cloud. Registry names are unique within their Kafka cluster.
TLS
KCM verifies the certificate and the host name of the registry. For a self-signed or private CA certificate, add the CA in Settings > Trusted certificates: it applies at once, without restart.
Formats
| Format | Browse subjects | Create, check compatibility | Consume and produce |
|---|---|---|---|
| Avro | Yes | Yes | Yes, including nested records, unions, enums and fixed types |
| JSON Schema (draft-04 to 2020-12) | Yes | Yes | Yes, values and keys validated before sending |
| Protobuf | Yes | Can be registered | Messages are shown as raw bytes with their schema id; producing is not supported yet |
Schemas created from KCM keep the type chosen in the form (before 1.3.0 they were all registered as Avro).
Subjects and versions
- Browse subjects, their versions and the schema of each version; look a schema up by its id and see the subjects that use it.
- Register a new version after a compatibility check against the existing versions.
- Set the compatibility level of a subject, or of the whole registry (cluster ADMIN). A guide explains each level.
- Delete a version or a subject.
Access
- A role on the Kafka cluster applies to its registries: VIEWER reads, EDITOR and ADMIN write.
- Subject grants (
DESCRIBE,CREATE,DELETE,ALTER,ALL, literal or prefixed) give access to chosen subjects to users without a cluster role. See Fine-grained grants. - Managing registry connections needs ADMIN on the cluster.
- The
AUDITORrole does not see schema content.