X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fsparky-be.git;a=blobdiff_plain;f=README.MD;h=bfbbaf8494fad0669b50e322963bbae937c1b078;hp=59f599345c77625e260f6703c0f360d410410615;hb=refs%2Fheads%2Fmaster;hpb=570fbbc23ea65c4cdb10da04e37263f489b9b357 diff --git a/README.MD b/README.MD index 59f5993..bfbbaf8 100644 --- a/README.MD +++ b/README.MD @@ -1,5 +1,7 @@ # Sparky - Inventory UI Service +[![alt text](https://bestpractices.coreinfrastructure.org/projects/1737/badge)](https://bestpractices.coreinfrastructure.org/projects/1737) + ## Overview _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. @@ -9,6 +11,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_