summaryrefslogtreecommitdiffstats
path: root/docs/apex/APEX-User-Manual.rst
diff options
context:
space:
mode:
authorRam Krishna Verma <ram_krishna.verma@bell.ca>2022-11-17 15:54:42 -0500
committerRam Krishna Verma <ram_krishna.verma@bell.ca>2022-11-17 15:59:59 -0500
commitd873084e17de71c8ef61e844083a2e8d4e32773e (patch)
tree41cbb09f16cad4e1ee0f989183b2be87164a2c45 /docs/apex/APEX-User-Manual.rst
parent664c0b827ada2cb7eb399a62a1eba39606ddd9db (diff)
Add documents for KafkaAvroSerializer support in apex-pdp
Issue-ID: POLICY-4460 Change-Id: Ica77ff1aafd10b098bdcae72041f3176b29dac40 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Diffstat (limited to 'docs/apex/APEX-User-Manual.rst')
-rw-r--r--docs/apex/APEX-User-Manual.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/apex/APEX-User-Manual.rst b/docs/apex/APEX-User-Manual.rst
index c0a7aaca..79232042 100644
--- a/docs/apex/APEX-User-Manual.rst
+++ b/docs/apex/APEX-User-Manual.rst
@@ -2626,6 +2626,31 @@ Kafka Input
Kindly note that the above Kafka properties is just a reference,
and the actual properties required depends on the Kafka server installation.
+ In cases where the message produced in Kafka topic has been serialized using KafkaAvroSerializer,
+ then the following parameters needs to be additionally added to `KafkaProperties` for the consumer
+ to have the capability of deserializing the message properly while consuming.
+
+ .. container:: listingblock
+
+ .. container:: content
+
+ .. code::
+
+ [
+ "value.deserializer",
+ "io.confluent.kafka.serializers.KafkaAvroDeserializer"
+ ],
+ [
+ "schema.registry.url",
+ "<url of the schema registry configured in Kafka cluster for registering Avro schemas>"
+ ]
+
+ .. container:: paragraph
+
+ For more details on how to setup schema registry for Kafka cluster,
+ kindly take a look `here <https://github.com/confluentinc/schema-registry/blob/master/README.md>`__.
+
+
Kafka Output
============
.. container:: paragraph