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.
At this time, Sparky has two views available for use:
View and Inspect - Graph based view of entities within AAI.
VNFs - Aggregation based view of VNFs within AAI.
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
After cloning the project, execute the following Maven command from the project's top level directory to build the project:
> mvn clean install
After a successful install, build the docker image:
> docker build -t openecomp/sparky target
Push the Docker image that you have built to your Docker repository and pull it down to the location that you will be running Sparky.
Create the following directories on the host machine:
/logs
/opt/app/sparky/appconfig
You will be mounting these as data volumes when you start the Docker container.
Clone the "test-config" repo to a seperate directory. 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.
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.
sparky-core.xml
- searchServiceRestEndpointConfig
- endpointIpAddress ( ip address of the Search Data Service )
- endpointServerPort ( server port of Search Data Service )
sparky-core-sync.xml
-
elasticSearchRestEndpointConfig
- endpointIpAddress (ElasticSearch server ip address)
- endpointServerPort (ElasticSearch transport server port. Default: 9200)
-
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 ONAP Portal instance, use the two files above to configure against the proper Portal instance.
Sparky requires:
- AAI instance as the main driver behind data.
- Elasticsearch instance for data storage.
- Search-Data-Service instance for search functionality.
- ONAP Portal instance for authentication.