Skip to content
2 changes: 1 addition & 1 deletion local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ content:
- url: https://github.com/redpanda-data/docs
branches: [v/*, shared, site-search,'!v-end-of-life/*']
- url: https://github.com/redpanda-data/cloud-docs
branches: 'main'
branches: 'DOC-1939-Add-Schema-Validation-topic-in-general-and-cluster-property-enable_schema_id_validation-to-cloud-docs'
- url: https://github.com/redpanda-data/redpanda-labs
branches: main
start_paths: [docs,'*/docs']
Expand Down
2 changes: 2 additions & 0 deletions modules/manage/pages/schema-reg/schema-id-validation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ To customize the subject name strategy per topic, set the following client topic
* Set xref:reference:properties/topic-properties.adoc#redpandakeyschemavalidation[`redpanda.key.schema.id.validation`] to `true` to enable key schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandakeysubjectnamestrategy[`redpanda.key.subject.name.strategy`] to the desired subject name strategy for keys of the topic (default: `TopicNameStrategy`).
* Set xref:reference:properties/topic-properties.adoc#redpandavalueschemavalidation[`redpanda.value.schema.id.validation`] to `true` to enable value schema ID validation for the topic, and set xref:reference:properties/topic-properties.adoc#redpandavaluesubjectnamestrategy[`redpanda.value.subject.name.strategy`] to the desired subject name strategy for values of the topic (default: `TopicNameStrategy`).

ifndef::env-cloud[]
[NOTE]
====
The `redpanda.` properties have corresponding `confluent.` properties.
Expand All @@ -114,6 +115,7 @@ The `redpanda.*` and `confluent.*` properties are compatible. Either or both can

If `subject.name.strategy` is prefixed with `confluent.`, the available subject name strategies must be prefixed with `io.confluent.kafka.serializers.subject.`. For example, `io.confluent.kafka.serializers.subject.TopicNameStrategy`.
====
endif::[]

NOTE: To support schema ID validation for compressed topics, a Redpanda broker decompresses each batch written to it so it can access the schema ID.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5011,10 +5011,13 @@ endif::[]
|===


// tag::redpanda-cloud[]
=== enable_schema_id_validation

Controls whether Redpanda validates schema IDs in records and which topic properties are enforced.

CAUTION: This property could cause decompression across topics and increase CPU load.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@micheleRP "NOTE: enabling this property will trigger decompression of message batches for topics on which validation is configured, leading to a modest increase in CPU load. We recommend monitoring CPU utilization after topics are configured"

@micheleRP note the TOPIC configurations are probably elsewhere in the ID validation docs(confluent.<key/value>.schema.validation)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mattschumpert I conditionalized out these topic properties for Cloud, since we don't document them in Cloud docs (see here). Please confirm that this is correct!


Values:

* `none`: Schema validation is disabled (no schema ID checks are done). Associated topic properties cannot be modified.
Expand Down Expand Up @@ -5070,6 +5073,7 @@ endif::[]

|===

// end::redpanda-cloud[]

// tag::redpanda-cloud[]
=== enable_shadow_linking
Expand Down