Initial commit for AAI-UI(sparky-backend)

[aai/sparky-be.git] / README.MD

diff --git a/README.MD b/README.MD
new file mode 100644 (file)
index 0000000..0bc0439
--- /dev/null
+++ b/README.MD
@@ -0,0 +1,73 @@
+# Sparky - Inventory UI Service\r
+\r
+## Overview\r
+_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
+\r
+At this time, _Sparky_ has two views available for use:\r
+\r
+[View and Inspect](./VIEW_INSPECT.md) - Graph based view of entities within AAI.\r
+\r
+[VNFs](./VNFS.md) - Aggregation based view of VNFs within AAI.\r
+\r
+## Getting Started\r
+\r
+### Building _Sparky_\r
+\r
+After cloning the project, execute the following Maven command from the project's top level directory to build the project:\r
+\r
+    > mvn clean install\r
+\r
+After a successful install, build the docker image:\r
+\r
+    > docker build -t openecomp/sparky target \r
+\r
+### Deploying _Sparky_\r
+\r
+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
+\r
+**Create the following directories on the host machine:**\r
+\r
+    /logs\r
+    /opt/app/sparky/appconfig\r
+\r
+You will be mounting these as data volumes when you start the Docker container.\r
+\r
+#### 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
+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
+\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
+\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
+\r
+**elasticsearch.properties**\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
+\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
+\r
+### Dependencies\r
+\r
+_Sparky_ requires:\r
+\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