Update Sparky README files

Issue-ID: AAI-743
Change-Id: Ia9f450e6571d85b0bed5b4b9dd7d38a98513313f
Signed-off-by: dave.adams (da490c) <dave.adams@amdocs.com>

diff --git a/README.MD b/README.MD
index 0bc0439..59f5993 100644 (file)
--- a/README.MD
+++ b/README.MD
@@ -35,33 +35,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 +72,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

diff --git a/VNFS.MD b/VNFS.MD
index e83eb3e..9af0d59 100644 (file)
--- a/VNFS.MD
+++ b/VNFS.MD
@@ -2,7 +2,7 @@
 \r
 ### _VNFs_ Overview\r
 \r
-_VNFs_ is an aggregation based view that provides aggregate counts of VNFs based off of provsioning status and orchestration status.\r
+_VNFs_ is an aggregation based view that provides aggregate counts of VNFs based off of provsioning status and orchestration status.  There is slide out filtering panel that will allow filtering on different values from the data set.  The filters can be selected and cleared, and will have an immediate impact on the charts and graphs in this view.\r
 \r
 ### Navigation to _VNFs_\r
 \r