From: Francis Paquette <francis.paquette@amdocs.com>
Date: Tue, 20 Mar 2018 20:34:42 +0000 (-0400)
Subject: Adding interfaces in documentation
X-Git-Tag: v1.2.0~28
X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fsparky-be.git;a=commitdiff_plain;h=ef7f255958e541ffaec0fd2a977440dd7b6fd6b8

Adding interfaces in documentation

Issue-ID: AAI-916
Change-Id: I1eb6ad5a54cf19e71cf891744eefd10ad8a500d1
Signed-off-by: Francis Paquette <francis.paquette@amdocs.com>
---

diff --git a/README.MD b/README.MD
index 59f5993..63ac810 100644
--- a/README.MD
+++ b/README.MD
@@ -9,6 +9,26 @@ At this time, _Sparky_ has two views available for use:
 
 [VNFs](./VNFS.md) - Aggregation based view of VNFs within AAI.
 
+## Interfaces
+
+User/Browser -> _Sparky_ port 9517 (HTTP) (can be configured as port 8000 HTTPS) 
+Purposes: 
+ - Suggestions requests
+ - data retrieval
+
+_Sparky_ -> AAI HA proxy port 8443 (REST)
+Purposes: 
+ - data retrieval
+ - Index synchronization
+   
+_Sparky_ -> Elastic Search port 9200 (REST) 
+Purpose: 
+ - data retrieval (VNFs queries) 
+
+_Sparky_ -> Search data Service port 9509 (REST) 
+Purpose: 
+ - Data retrieval for search bar
+
 ## Getting Started
 
 ### Building _Sparky_