From: pwielebs <piotr.wielebski@nokia.com>
Date: Tue, 11 Sep 2018 08:55:41 +0000 (+0200)
Subject: User Documentation
X-Git-Tag: 1.1.0~9
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F69%2F65769%2F2;p=dcaegen2%2Fservices%2Fprh.git

User Documentation
- Adding README.md

Change-Id: I1d33531031ad904e1d1b09a8b4268984836759cb
Issue-ID: DCAEGEN2-398
Signed-off-by: pwielebs <piotr.wielebski@nokia.com>
---

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..15925058
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# PRH (PNF Registration Handler)
+
+Physical Network Function Registration Handler is responsible for registration of PNF (Physical Network Function) to 
+ONAP (Open Network Automation Platform) in plug and play manner. 
+
+## Introduction 
+
+PRH is delivered as one **Docker container** which hosts application server and can be started by `docker-compose`.
+
+## Functionality
+
+![](docs/prhAlgo.png)
+        
+## Compiling PRH
+
+Whole project (top level of PRH directory) and each module (sub module directory) can be compiled using 
+`mvn clean install` command.   
+
+## Main API Endpoints
+
+Running with dev-mode of PRH
+
+- **Heartbeat**: http://<container_address>:8100/**heartbeat** or https://<container_address>:8443/**heartbeat**
+
+- **Start PRH**: http://<container_address>:8100/**start** or https://<container_address>:8433/**start**
+
+- **Stop PRH**: http://<container_address>:8100/**stopPrh** or https://<container_address>:8433/**stopPrh**    
+
+## Maven GroupId:
+
+org.onap.dcaegen2.services
+
+### Maven Parent ArtifactId:
+
+dcae-services
+
+### Maven Children Artifacts:
+1. prh-app-server: Pnf Registration Handler (PRH) server
+2. prh-aai-client: Contains implementation of AAI client
+3. prh-dmaap-client: Contains implementation of DmaaP client
+4. prh-commons: Common code for whole prh modules
+
+
+## License
+
+Copyright (C) 2018 NOKIA Intellectual Property. All rights reserved.
+[License](http://www.apache.org/licenses/LICENSE-2.0)
+
diff --git a/docs/prhAlgo.png b/docs/prhAlgo.png
new file mode 100644
index 00000000..3d3c8093
Binary files /dev/null and b/docs/prhAlgo.png differ