Skip to content

Commit b4cdd4a

Browse files
authored
Clarify that serde.protobuf should not be configured when using Schema Registry (#1174)
1 parent 47e4bd0 commit b4cdd4a

1 file changed

Lines changed: 6 additions & 10 deletions

File tree

modules/console/pages/config/deserialization.adoc

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,11 @@ Most Kafka clients that serialize Protobuf messages put the serialized byte arra
2121
[[sr-protobuf]]
2222
=== Use Schema Registry for Protobuf
2323

24-
If you use a Schema Registry for Protobuf deserialization, Redpanda Console can automatically fetch and use the required schemas without the need for <<topic-mapping, manual topic mappings>>. Because the schema information (including which Protobuf message type to use) is embedded in the messages, you do not need to manually configure mappings for each topic. The Schema Registry provides the necessary schema information to deserialize the messages.
24+
If you use a Schema Registry for Protobuf deserialization, Redpanda Console can automatically fetch and use the required schemas without the need for manual topic mappings or additional configuration.
2525

26-
To configure Protobuf deserialization using Schema Registry, add the following to your configuration file in addition to the <<sr, `schemaRegistry` configuration>>:
26+
When using Schema Registry for Protobuf, you must not configure `serde.protobuf`. Redpanda Console detects and uses the Protobuf schemas from the Schema Registry automatically.
2727

28-
[,yaml]
29-
----
30-
serde:
31-
protobuf:
32-
enabled: true
33-
----
34-
35-
- `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
28+
If you configure `serde.protobuf`, it enables manual deserialization mode, which requires you to specify topic mappings and source providers. Without those, Redpanda Console fails to start due to validation errors.
3629

3730
When using Schema Registry for Protobuf, you do not need to provide specific topic mappings, as the schemas will be fetched dynamically.
3831

@@ -73,6 +66,7 @@ serde:
7366
# keyProtoType: Not specified because the key is a plain string
7467
----
7568

69+
* `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
7670
* `serde.protobuf.mappings.topicName`: The name of the Kafka topic.
7771
* `serde.protobuf.mappings.valueProtoType`: The fully-qualified Protobuf type for the message value.
7872
* `serde.protobuf.mappings.keyProtoType`: Specify the key Protobuf type if the key is not a plain string.
@@ -101,6 +95,7 @@ serde:
10195
- /etc/protos
10296
----
10397

98+
* `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
10499
* `serde.protobuf.fileSystem.paths`: Paths to directories where Protobuf files are stored.
105100
* `serde.protobuf.fileSystem.refreshInterval`: The frequency at which Redpanda Console checks for updates to these files.
106101

@@ -131,6 +126,7 @@ serde:
131126
password: redacted
132127
----
133128

129+
* `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
134130
* `serde.protobuf.git.repository.url`: The URL of the GitHub repository containing your Protobuf files.
135131
* `serde.protobuf.git.basicAuth`: Basic authentication credentials, often an API token for private repositories.
136132
* `serde.protobuf.git.refreshInterval`: Frequency at which the repository is polled for updates.

0 commit comments

Comments
 (0)