aboutsummaryrefslogtreecommitdiffstats
path: root/docs/apex
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-28 15:31:45 +0000
commit6ff04aec5e0f8994890d0586c4482707e63eec5c (patch)
tree59dc015cc32ac6cb9ca2753886f63be4db0a2376 /docs/apex
parentfadfd6e3fb50499a77c9cd1381802b142ec152d5 (diff)
Add documents for KafkaAvroSerializer support in apex-pdphonolulu
Issue-ID: POLICY-4460 Change-Id: Ica77ff1aafd10b098bdcae72041f3176b29dac40 Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca> (cherry picked from commit d873084e17de71c8ef61e844083a2e8d4e32773e)
Diffstat (limited to 'docs/apex')
-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 75032466..948ead14 100644
--- a/docs/apex/APEX-User-Manual.rst
+++ b/docs/apex/APEX-User-Manual.rst
@@ -2644,6 +2644,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