diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 6 | ||||
| -rw-r--r-- | docs/view_inspect.rst | 44 | ||||
| -rw-r--r-- | docs/vnfs.rst | 25 |
3 files changed, 73 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index bc69e1b..f3e7894 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,9 +12,11 @@ It is divided into both a front-end (the code that constructs the GUI) and a bac At this time, Sparky has two views available for use: -`View and Inspect <./VIEW_INSPECT.md>`_ - Graph-based view of entities within AAI +.. toctree:: + :maxdepth: 1 -`VNFs <./VNFS.md>`_ - Aggregation-based view of VNFs within AAI + Graph-based view of entities within AAI <./view_inspect> + Aggregation-based view of VNFs within AAI VNFs <./vnfs> Interactions ------------ diff --git a/docs/view_inspect.rst b/docs/view_inspect.rst new file mode 100644 index 0000000..d25f95f --- /dev/null +++ b/docs/view_inspect.rst @@ -0,0 +1,44 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Sparky - Inventory UI Service +============================= + +*View & Inspect* Overview +~~~~~~~~~~~~~~~~~~~~~~~~~ + +*View & Inspect* provides a graph based view of elements within AAI. A +single entity is the entry point into each graph, and from that base +element a graph is generated based off relationships. + +Navigation to *View & Inspect* +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The *View & Inspect* view can be reached by two means: + +1. Main navigation menu +2. Selecting a search result related to an entity instance (e.g. an + entity called readme-entity) + +Using *View & Inspect* +~~~~~~~~~~~~~~~~~~~~~~ + +*View & Inspect* is driven by using the search bar at the top of the UI +to find and select entity instances. Once an instance has been slected, +a request is proccessed in *Sparky's* backend component that generates a +graph representation of the selected entity. The graph data is returned +to *View & Inspect* and rendered on screen. + +Node Details +^^^^^^^^^^^^ + +Upon node selection, the selected graph node details will appear in a +panel to the right of the graph titled, *Node Details*. + +Interacting with the Graph +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The graph can be panned by clicking and holding empty space amongst the +graph and moving the mouse. This will pan the entire graph. The graph +can be zoomed in and out by using a mouse scroll wheel. Nodes in the +graph can be select by clicking on them. Nodes in the graph can be moved +by clicking, holding, and dragging them using the mouse. diff --git a/docs/vnfs.rst b/docs/vnfs.rst new file mode 100644 index 0000000..e7f39ef --- /dev/null +++ b/docs/vnfs.rst @@ -0,0 +1,25 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Sparky - Inventory UI Service +============================= + +*VNFs* Overview +~~~~~~~~~~~~~~~ + +*VNFs* is an aggregation based view that provides aggregate counts of +VNFs based off of provsioning status and orchestration status. + +Navigation to *VNFs* +~~~~~~~~~~~~~~~~~~~~ + +1. Main navigation menu +2. Selecting a search result related to an aggregation result (e.g. and + VNFs) + +Using *VNFs* +~~~~~~~~~~~~ + +*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. |