README.MD

   1 # Sparky - Inventory UI Service\r
   2 \r
   3 ## Overview\r
   4 _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
   5 \r
   6 At this time, _Sparky_ has two views available for use:\r
   7 \r
   8 [View and Inspect](./VIEW_INSPECT.md) - Graph based view of entities within AAI.\r
   9 \r
  10 [VNFs](./VNFS.md) - Aggregation based view of VNFs within AAI.\r
  11 \r
  12 ## Getting Started\r
  13 \r
  14 ### Building _Sparky_\r
  15 \r
  16 After cloning the project, execute the following Maven command from the project's top level directory to build the project:\r
  17 \r
  18     > mvn clean install\r
  19 \r
  20 After a successful install, build the docker image:\r
  21 \r
  22     > docker build -t openecomp/sparky target \r
  23 \r
  24 ### Deploying _Sparky_\r
  25 \r
  26 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_.\r
  27 \r
  28 **Create the following directories on the host machine:**\r
  29 \r
  30     /logs\r
  31     /opt/app/sparky/appconfig\r
  32 \r
  33 You will be mounting these as data volumes when you start the Docker container.\r
  34 \r
  35 #### Clone Configuration Repo\r
  36 \r
  37 Clone the "test-config" repo to a seperate directory.\r
  38 Navigate to <test-config repo location>/sparky/appconfig (will contain files such as aai.properties).\r
  39 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
  40 \r
  41 #### Edits to property files in /opt/app/sparky/appconfig\r
  42 \r
  43 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
  44 \r
  45 **search-service.properties**\r
  46 \r
  47 search-service.ipAddress=<ip address / hostname of the search-data-service that this instance will use>\r
  48 search-service.httpPort=<http port of the search-data-service that this instance will use>\r
  49 \r
  50 **aai.properties**\r
  51 \r
  52 aai.rest.host=<ip address / hostname of the aai that this instance will use>\r
  53 aai.rest.port=<rest port of the aai that this instance will use>\r
  54 \r
  55 **elasticsearch.properties**\r
  56 \r
  57 elasticsearch.ipAddress=<ip address / hostname of the elasticsearch that this instance will use>\r
  58 elasticsearch.httpPort=<http port of the elasticsearch that this instance will use>\r
  59 elasticsearch.javaApiPort=<java api port of the elasticsearch that this instance will use>\r
  60 \r
  61 **portal/portal.properties**\r
  62 **portal/portal-authentication.properties**\r
  63 \r
  64 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
  65 \r
  66 ### Dependencies\r
  67 \r
  68 _Sparky_ requires:\r
  69 \r
  70 - AAI instance as the main driver behind data.\r
  71 - Elasticsearch instance for data storage.\r
  72 - search-data-service instance for search functionality.\r
  73 - eCOMP Portal instance for authentication.