e7f39effd22b1abf7a8843bdef1b7bff5486ecb4
[aai/sparky-be.git] / docs / vnfs.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 Sparky - Inventory UI Service
4 =============================
5
6 *VNFs* Overview
7 ~~~~~~~~~~~~~~~
8
9 *VNFs* is an aggregation based view that provides aggregate counts of
10 VNFs based off of provsioning status and orchestration status.
11
12 Navigation to *VNFs*
13 ~~~~~~~~~~~~~~~~~~~~
14
15 1. Main navigation menu
16 2. Selecting a search result related to an aggregation result (e.g. and
17    VNFs)
18
19 Using *VNFs*
20 ~~~~~~~~~~~~
21
22 *VNFs* is driven by using the search bar at the top of the UI to find
23 and select aggregation queries. Once selected, the aggregation queries
24 will be sent to the *Sparky* backend component for processing. When a
25 result set has been determined *VNFs* will render the data.