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/console/pages/config/deserialization.adoc
+6-10Lines changed: 6 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,18 +21,11 @@ Most Kafka clients that serialize Protobuf messages put the serialized byte arra
21
21
[[sr-protobuf]]
22
22
=== Use Schema Registry for Protobuf
23
23
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.
25
25
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.
27
27
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.
36
29
37
30
When using Schema Registry for Protobuf, you do not need to provide specific topic mappings, as the schemas will be fetched dynamically.
38
31
@@ -73,6 +66,7 @@ serde:
73
66
# keyProtoType: Not specified because the key is a plain string
74
67
----
75
68
69
+
* `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
76
70
* `serde.protobuf.mappings.topicName`: The name of the Kafka topic.
77
71
* `serde.protobuf.mappings.valueProtoType`: The fully-qualified Protobuf type for the message value.
78
72
* `serde.protobuf.mappings.keyProtoType`: Specify the key Protobuf type if the key is not a plain string.
@@ -101,6 +95,7 @@ serde:
101
95
- /etc/protos
102
96
----
103
97
98
+
* `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
104
99
* `serde.protobuf.fileSystem.paths`: Paths to directories where Protobuf files are stored.
105
100
* `serde.protobuf.fileSystem.refreshInterval`: The frequency at which Redpanda Console checks for updates to these files.
106
101
@@ -131,6 +126,7 @@ serde:
131
126
password: redacted
132
127
----
133
128
129
+
* `serde.protobuf.enabled`: Set to `true` to enable Protobuf deserialization.
134
130
* `serde.protobuf.git.repository.url`: The URL of the GitHub repository containing your Protobuf files.
135
131
* `serde.protobuf.git.basicAuth`: Basic authentication credentials, often an API token for private repositories.
136
132
* `serde.protobuf.git.refreshInterval`: Frequency at which the repository is polled for updates.
0 commit comments