update link to upper-constraints.txt

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

diff --git a/README.MD b/README.MD
index 0bc0439..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
@@ -35,33 +57,36 @@ You will be mounting these as data volumes when you start the Docker container.
 #### Clone Configuration Repo\r
 \r
 Clone the "test-config" repo to a seperate directory.\r
-Navigate to <test-config repo location>/sparky/appconfig (will contain files such as aai.properties).\r
+Navigate to <test-config repo location>/sparky/appconfig (will contain files such as aaiui_filters.json and authentication files).\r
 Copy the entire contents of <test-config repo location>/sparky/appconfig into the /opt/app/sparky/appconfig directory you created in an above step.\r
+Copy the entire contents of <test-config repo location>/sparky/dynamic into the /opt/app/sparky/dynamic directory you created in an above step.\r
+\r
+The *dynamic* folder contains spring-beans and camel routes.  The spring-beans must be updated with environmental configuration, to enable correct operation. \r
 \r
 #### Edits to property files in /opt/app/sparky/appconfig\r
 \r
 Listed below are the values that will need to be updated to make _Sparky_ operate properly. The config files contain comments on the contents not listed here.\r
 \r
-**search-service.properties**\r
-\r
-search-service.ipAddress=<ip address / hostname of the search-data-service that this instance will use>\r
-search-service.httpPort=<http port of the search-data-service that this instance will use>\r
-\r
-**aai.properties**\r
+**sparky-core.xml**\r
 \r
-aai.rest.host=<ip address / hostname of the aai that this instance will use>\r
-aai.rest.port=<rest port of the aai that this instance will use>\r
+- searchServiceRestEndpointConfig\r
+       - endpointIpAddress ( ip address of the Search Data Service )\r
+       - endpointServerPort ( server port of Search Data Service ) \r
 \r
-**elasticsearch.properties**\r
+**sparky-core-sync.xml**\r
+ \r
+- elasticSearchRestEndpointConfig\r
+    - endpointIpAddress (ElasticSearch server ip address)\r
+    - endpointServerPort (ElasticSearch transport server port.  Default: 9200)\r
 \r
-elasticsearch.ipAddress=<ip address / hostname of the elasticsearch that this instance will use>\r
-elasticsearch.httpPort=<http port of the elasticsearch that this instance will use>\r
-elasticsearch.javaApiPort=<java api port of the elasticsearch that this instance will use>\r
+- aaiRestEndpointConfig\r
+    - endpointIpAddress (AAI server ip address)\r
+    - endpointServerPort (AAI server port.  Default: 8443)\r
 \r
 **portal/portal.properties**\r
 **portal/portal-authentication.properties**\r
 \r
-If this instance of _Sparky_ will be served in an eCOMP Portal instance, use the two files above to configure against the proper Portal instance.\r
+If this instance of _Sparky_ will be served in an ONAP Portal instance, use the two files above to configure against the proper Portal instance.\r
 \r
 ### Dependencies\r
 \r
@@ -69,5 +94,5 @@ _Sparky_ requires:
 \r
 - AAI instance as the main driver behind data.\r
 - Elasticsearch instance for data storage.\r
-- search-data-service instance for search functionality.\r
-- eCOMP Portal instance for authentication.
\ No newline at end of file
+- Search-Data-Service instance for search functionality.\r
+- ONAP Portal instance for authentication.
\ No newline at end of file