update link to upper-constraints.txt

[aai/sparky-be.git] / README.MD

diff --git a/README.MD b/README.MD
index 59f5993..bfbbaf8 100644 (file)
--- a/README.MD
+++ b/README.MD
@@ -1,5 +1,7 @@
 # Sparky - Inventory UI Service\r
 \r
+[![alt text](https://bestpractices.coreinfrastructure.org/projects/1737/badge)](https://bestpractices.coreinfrastructure.org/projects/1737)\r
+\r
 ## Overview\r
 _Sparky_ is a service that interacts with AAI and provides users a UI to view and analyze AAI data. The main goal behind _Sparky_ is providing a more user friendly and clear view of AAI data.\r
 \r
@@ -9,6 +11,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