X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=README.MD;h=59f599345c77625e260f6703c0f360d410410615;hb=82f75562e7e969a792436fd7908423cc1c85fba5;hp=0bc04399e51b4fdb1bf28145be7a3a5679d671bb;hpb=a23ea1abfc73e3baca3bbf982de1caffbb2f94cf;p=aai%2Fsparky-be.git diff --git a/README.MD b/README.MD index 0bc0439..59f5993 100644 --- 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 Clone the "test-config" repo to a seperate directory. -Navigate to /sparky/appconfig (will contain files such as aai.properties). +Navigate to /sparky/appconfig (will contain files such as aaiui_filters.json and authentication files). Copy the entire contents of /sparky/appconfig into the /opt/app/sparky/appconfig directory you created in an above step. +Copy the entire contents of /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= -search-service.httpPort= - -**aai.properties** +**sparky-core.xml** -aai.rest.host= -aai.rest.port= +- 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= -elasticsearch.httpPort= -elasticsearch.javaApiPort= +- 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 +72,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