docs/platform/vnfs.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2
   3 Sparky - VNFs
   4 ==============
   5
   6 *VNFs* Overview
   7 ~~~~~~~~~~~~~~~
   8
   9 *VNFs* is an aggregation-based view that provides aggregate counts of
  10 VNFs based off of provisioning status and orchestration status.
  11
  12 *VNFs* Features
  13 ~~~~~~~~~~~~~~~
  14 With VNFs UI, users can:
  15    * Search for generic-vnfs by attribute value(s) specified in the search box using suggested search terms.
  16    * View search results aggregated to display:
  17       - A count of the total VNFs returned by the search
  18       - A count of the VNFs for each prov-status values.
  19    * Filter out data to reduce the amount of data displayed to the user. Users can  filter data based on:
  20        - Orchestration status
  21        - Provisioning status
  22        - Network function type
  23        - Network function role
  24
  25 Navigation to *VNFs*
  26 ~~~~~~~~~~~~~~~~~~~~
  27
  28 1. Main navigation menu
  29 2. Selecting a search result related to an aggregation result (e.g. and
  30    VNFs)
  31
  32 Using *VNFs*
  33 ~~~~~~~~~~~~
  34
  35 *VNFs* is driven by using the search bar at the top of the UI to find
  36 and select aggregation queries. Once selected, the aggregation queries
  37 will be sent to the *Sparky* backend component for processing. When a
  38 result set has been determined *VNFs* will render the data - as below:
  39
  40 Note: The OXM schema defines the services and resources archetypes and mappings to Java types that are used by A&AI to define the REST endpoints for reading and manipulating the inventory data. The OXM file has been annotated with suggestible attributes. Sparky communicates with Synapse (data-router) to update ElasticSearch as entities are created/updated and deleted.
  41
  42
  43 .. image:: images/view6.jpg
  44    :height: 150px
  45    :width: 270 px
  46    :scale: 100 %
  47    :alt: alternate text
  48    :align: center