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