summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFrancis Paquette <francis.paquette@amdocs.com>2018-03-20 16:34:42 -0400
committerFrancis Paquette <francis.paquette@amdocs.com>2018-03-21 11:05:33 -0400
commitef7f255958e541ffaec0fd2a977440dd7b6fd6b8 (patch)
tree4d35c2913b6078504a1ad350f603d50433c7baef
parent1f928a54df22e2efa1c135a9d16ccb278caccd31 (diff)
Adding interfaces in documentation
Issue-ID: AAI-916 Change-Id: I1eb6ad5a54cf19e71cf891744eefd10ad8a500d1 Signed-off-by: Francis Paquette <francis.paquette@amdocs.com>
-rw-r--r--README.MD20
1 files changed, 20 insertions, 0 deletions
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_