docs/index.rst

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