X-Git-Url: https://gerrit.onap.org/r/gitweb?p=aai%2Fsparky-be.git;a=blobdiff_plain;f=README.MD;h=bfbbaf8494fad0669b50e322963bbae937c1b078;hp=0bc04399e51b4fdb1bf28145be7a3a5679d671bb;hb=refs%2Fheads%2Fmaster;hpb=b4922d319d293894fddd512d29b5f0d1411915d9

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