Schema Registry Subjects

Mon, 01 Jan 0001 00:00:00 +0000

SchemaRegistrySubject resources are used to define the subject schemas you want to manage on your SchemaRegistry. A SchemaRegistrySubject resource defines the schema, the compatibility level, and the references to be associated with a subject version.

Definition Format of `SchemaRegistrySubject`

Below is the overall structure of the SchemaRegistrySubject resource.

apiVersion: "schemaregistry.jikkou.io/v1beta2" # The api version (required)
kind: "SchemaRegistrySubject" # The resource kind (required)
metadata:
 name: <The name of the subject>  # (required)
 labels: { }
 annotations: { }
spec:
 schemaRegistry:
 vendor: <vendor_name>  # (optional) The vendor of the SchemaRegistry, e.g., Confluent, Karapace, etc
 compatibilityLevel: <compatibility_level>  # (optional) The schema compatibility level for this subject.
 schemaType: <The schema format> # (required) Accepted values are: AVRO, PROTOBUF, JSON
 schema:
 $ref: <url or path>  # 
 references: # Specifies the names of referenced schemas (optional array).
 - name: <string>  # The name for the reference.
 subject: <string>  # The subject under which the referenced schema is registered.
 version: <string>  # The exact version of the schema under the registered subject.
]

Metadata

The metadata.name property is mandatory and specifies the name of the Subject.

Resources on Jikkou

Schema Registry Subjects

Definition Format of SchemaRegistrySubject

Metadata

Definition Format of `SchemaRegistrySubject`