Initial commit for AAI-UI(sparky-backend)

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

diff --git a/VNFS.MD b/VNFS.MD
new file mode 100644 (file)
index 0000000..e83eb3e
--- /dev/null
+++ b/VNFS.MD
@@ -0,0 +1,14 @@
+# Sparky - Inventory UI Service\r
+\r
+### _VNFs_ Overview\r
+\r
+_VNFs_ is an aggregation based view that provides aggregate counts of VNFs based off of provsioning status and orchestration status.\r
+\r
+### Navigation to _VNFs_\r
+\r
+1. Main navigation menu\r
+2. Selecting a search result related to an aggregation result (e.g. <orch-status> and <prov-status> VNFs)\r
+\r
+### Using _VNFs_\r
+\r
+_VNFs_ is driven by using the search bar at the top of the UI to find and select aggregation queries. Once selected, the aggregation queries will be sent to the _Sparky_ backend component for processing. When a result set has been determined _VNFs_ will render the data.
\ No newline at end of file