X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=blobdiff_plain;f=docs%2Ftesting%2Fuser%2Fuserguide%2F12-nsb-overview.rst;h=012ea6c3dfb72434af532b7ef9f0157ab5ec13d4;hb=a2d14aea3e8a02e7f4ec0ef41f36aca6100d85e5;hp=ec4df1caefce919887135a45633cf2b2fc1cc631;hpb=fa6509b1bde3d7c2fecad3ffab5a050a27346dae;p=yardstick.git

diff --git a/docs/testing/user/userguide/12-nsb-overview.rst b/docs/testing/user/userguide/12-nsb-overview.rst
index ec4df1cae..012ea6c3d 100644
--- a/docs/testing/user/userguide/12-nsb-overview.rst
+++ b/docs/testing/user/userguide/12-nsb-overview.rst
@@ -56,7 +56,7 @@ NSB extension includes:
 
 * Generic data models of Network Services, based on ETSI spec
   `ETSI GS NFV-TST 001`_
-* Standalone :term:`context` for VNF testing with SRIOV, OVS, OVS-DPDK, etc
+* Standalone :term:`context` for VNF testing SRIOV, OVS, OVS-DPDK, etc
 * Generic VNF configuration models and metrics implemented with Python
   classes
 * Traffic generator features and traffic profiles
@@ -65,6 +65,14 @@ NSB extension includes:
     * L4-L7 state-full traffic profiles
     * Tunneling protocol/network overlay support
 
+* Scenarios that handle NSB test cases execution
+
+    * NSPerf - scenario that handles generic NSB test case execution
+      (setup and init tg/vnf, trigger traffic on tg, collect kpi)
+    * NSPerf-RFC2544 - scenario that allows repeatable triggering of traffic on
+      traffic generators until test case acceptance criteria is met
+      (for example RFC2544 binary search)
+
 * Test case samples
 
     * Ping
@@ -121,6 +129,13 @@ Network Service framework performs the necessary test steps. It may involve:
 Components of Network Service
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
+.. TODO: provide a list of components in this section and describe them in
+   later sub-sections
+
+.. Components are the methodology, TGs, framework extensions, KPI collection,
+   Testcases, SampleVNFs
+.. Framework extentions include: VNF models, NSPerf Scenario, contexts
+
 * *Models for Network Service benchmarking*: The Network Service benchmarking
   requires the proper modelling approach. The NSB provides models using Python
   files and defining of NSDs and VNFDs.
@@ -169,6 +184,38 @@ for every combination of test case parameters:
 
 * RFC2544 throughput for various loss rate defined (1% is a default)
 
+KPI Collection
+^^^^^^^^^^^^^^
+
+KPI collection is the process of sampling KPIs at multiple intervals to allow
+for investigation into anomalies during runtime. Some KPI intervals are
+adjustable. KPIs are collected from traffic generators and NFVI for the SUT.
+There is already some reporting in NSB available, but NSB collects all KPIs for
+analytics to process.
+
+Below is an example list of basic KPIs:
+* Throughput
+* Latency
+* Packet delay variation
+* Maximum establishment rate
+* Maximum tear-down rate
+* Maximum simultaneous number of sessions
+
+Of course, there can be many other KPIs that will be relevant for a specific
+NFVI, but in most cases these KPIs are enough to give you a basic picture of
+the SUT. NSB also uses :term:`collectd` in order to collect the KPIs. Currently
+the following collectd plug-ins are enabled for NSB testcases:
+
+* Libvirt
+* Interface stats
+* OvS events
+* vSwitch stats
+* Huge Pages
+* RAM
+* CPU usage
+* Intel® PMU
+* Intel(r) RDT
+
 Graphical Overview
 ------------------