From: manuedelf <emmanuelle.delfour@orange.com>
Date: Tue, 6 Apr 2021 10:34:16 +0000 (+0200)
Subject: Add Dmaap client feature documentation
X-Git-Tag: 3.1.0~40
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=transportpce.git;a=commitdiff_plain;h=795a99706f10410ff5ab087679dfa8edb24dace6

Add Dmaap client feature documentation

JIRA: TRNSPRTPCE-406
Signed-off-by: manuedelf <emmanuelle.delfour@orange.com>
Change-Id: Ic9aa1cd794a562dca0f8a534e10b87c5a8b6190f
(cherry picked from commit ce0a5f273573a8f0f736f6b28ddb0c36d5a56fbb)
---

diff --git a/docs/developer-guide.rst b/docs/developer-guide.rst
index d818e0806..923b9d7bc 100644
--- a/docs/developer-guide.rst
+++ b/docs/developer-guide.rst
@@ -1439,6 +1439,15 @@ be connected together, through a point-to-point 100GE service running over a wav
     port is connected to Add/Drop nodes of the ROADM infrastructure are retrieved in order to
     abstract only relevant information.
 
+odl-transportpce-dmaap-client
+-----------------------------
+
+This feature allows TransportPCE application to send notifications on ONAP Dmaap Message router
+following service request results.
+This feature listens on NBI notifications and sends the PublishNotificationService content to
+Dmaap on the topic "unauthenticated.TPCE" through a POST request on /events/unauthenticated.TPCE
+It uses Jackson to serialize the notification to JSON and jersey client to send the POST request.
+
 Help
 ----
 
diff --git a/docs/user-guide.rst b/docs/user-guide.rst
index a68f749a4..34b0b38cb 100644
--- a/docs/user-guide.rst
+++ b/docs/user-guide.rst
@@ -55,6 +55,11 @@ TransportPCE User-Facing Features
    -  This feature is considered experimental. It provides transportPCE with an external connector to
       a MariaDB inventory currently limited to OpenROADM 1.2.1 devices.
 
+-  **feature odl-transportpce-dmaap-client**
+
+   -  This feature is considered experimental. It provides a REST client in order to send TPCE notifications
+      to ONAP Dmaap Message router.
+
 How To Start
 ------------
 
@@ -92,4 +97,21 @@ if you need the inventory external connector support limited to 1.2.1 OpenROADM
 
    feature:install odl-transportpce-inventory
 
+if you need the Dmaap connector support, before running Opendaylight, set DMAAP_BASE_URL as environment variable.
+For example, if the base url of your Dmaap server is "https://dmaap-mr:30226", then::
+
+    export DMAAP_BASE_URL=https://dmaap-mr:30226
+
+if your Dmaap server provides https connection through a self-signed certificate, do not forget to add the certificate
+to the JAVA truststore::
+
+    echo -n | openssl s_client -showcerts -connect dmaap-mr:30226 | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > /tmp/dmaap.crt
+    keytool -import -v -trustcacerts -alias dmaap -file /tmp/dmaap.crt -keystore /etc/ssl/certs/java/cacerts -keypass changeit -storepass changeit -noprompt
+
+where dmaap-mr:30226 is the url of your Dmaap server.
+
+Then run in karaf::
+
+   feature:install odl-transportpce-dmaap-client
+
 For a more detailed overview of the TransportPCE, see the :ref:`transportpce-dev-guide`.