From: Ram Krishna Verma <ram_krishna.verma@bell.ca>
Date: Thu, 17 Nov 2022 20:54:42 +0000 (-0500)
Subject: Add documents for KafkaAvroSerializer support in apex-pdp
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=d8ab9f676b34422a0afe29893699d32b98a91fee;p=policy%2Fparent.git

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>
(cherry picked from commit d873084e17de71c8ef61e844083a2e8d4e32773e)
Signed-off-by: Ram Krishna Verma <ram_krishna.verma@bell.ca>
---

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
diff --git a/docs/development/devtools/devtools.rst b/docs/development/devtools/devtools.rst
index cfd0ab61..c2ff409a 100644
--- a/docs/development/devtools/devtools.rst
+++ b/docs/development/devtools/devtools.rst
@@ -431,8 +431,6 @@ The profile is activated when:
         <!--  This property triggers generation of the Swagger documents -->
         <swagger.generation.phase>post-integration-test</swagger.generation.phase>
 
-    See the `CLAMP runtime POM <https://github.com/onap/policy-clamp/blob/master/runtime/pom.xml>`_ for an example of the usage of this property.
-
 2. Unit tests are being executed in the build, in other words when the *skipTests* flag is *false*.
 
 You **must** create a unit test in your module that generates the following file:
diff --git a/docs/development/devtools/drools-smoke.rst b/docs/development/devtools/drools-smoke.rst
index 07c812c4..9aec00a3 100644
--- a/docs/development/devtools/drools-smoke.rst
+++ b/docs/development/devtools/drools-smoke.rst
@@ -21,7 +21,7 @@ ONAP OOM kubernetes
 
 For installation instructions, please refer to the following documentation:
 
-`OOM Quick Start Guide <https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html>`_
+`OOM User Guide <https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/user_guides/oom_user_guide.html>`_
 
 At a minimum policy needs the following components installed:
 
diff --git a/docs/development/devtools/strimzi-policy.rst b/docs/development/devtools/strimzi-policy.rst
index 772281e8..ddd29a65 100644
--- a/docs/development/devtools/strimzi-policy.rst
+++ b/docs/development/devtools/strimzi-policy.rst
@@ -194,7 +194,7 @@ Download OOM repo
 The Policy kubernetes chart is located in the `OOM repository <https://github.com/onap/oom/tree/master/kubernetes/policy>`_.
 This chart includes different policy components referred as <policy-component-name>.
 
-Please refer to the `OOM documentation <https://docs.onap.org/projects/onap-oom/en/latest/oom_user_guide.html>`_ on how to install and deploy ONAP.
+Please refer to the `OOM documentation <https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/user_guides/oom_user_guide.html>`_ on how to install and deploy ONAP.
     .. code-block:: bash
 
        cd
diff --git a/docs/development/devtools/xacml-smoke.rst b/docs/development/devtools/xacml-smoke.rst
index 5b7eb8ea..ea15762c 100644
--- a/docs/development/devtools/xacml-smoke.rst
+++ b/docs/development/devtools/xacml-smoke.rst
@@ -21,7 +21,7 @@ ONAP OOM kubernetes
 
 For installation instructions, please refer to the following documentation:
 
-`OOM Quick Start Guide <https://docs.onap.org/projects/onap-oom/en/latest/oom_quickstart_guide.html>`_
+`OOM User Guide <https://docs.onap.org/projects/onap-oom/en/latest/sections/guides/user_guides/oom_user_guide.html>`_
 
 At a minimum policy needs the following components installed: