[docs] Update docs
[barometer.git] / docs / index.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) Anuket, Intel Corporation and others.
4
5 =========
6 Barometer
7 =========
8
9 :Project: `Barometer`_
10
11
12 :Authors: Maryam Tahhan <maryam.tahhan@intel.com>
13
14 :History:
15
16           ========== =====================================================
17            Date       Description
18           ========== =====================================================
19           16.12.2014 Project creation
20           ========== =====================================================
21
22 Barometer is the project that renames Software Fastpath service Quality Metrics
23 (SFQM) and updates its scope which was networking centric.
24
25 The goal of SFQM was to develop the utilities and libraries in DPDK to
26 support:
27
28 * Measuring Telco Traffic and Performance KPIs. Including:
29
30   * Packet Delay Variation (by enabling TX and RX time stamping).
31   * Packet loss (by exposing extended NIC stats).
32
33 * Performance Monitoring of the DPDK interfaces (by exposing
34   extended NIC stats + collectd Plugin).
35 * Detecting and reporting violations that can be consumed by VNFs
36   and higher level management systems (through DPDK Keep Alive).
37
38 With Barometer the scope is extended to monitoring the NFVI. The ability to
39 monitor the Network Function Virtualization Infrastructure (NFVI) where VNFs
40 are in operation will be a key part of Service Assurance within an NFV
41 environment, in order to enforce SLAs or to detect violations, faults or
42 degradation in the performance of NFVI resources so that events and relevant
43 metrics are reported to higher level fault management systems.
44 If physical appliances are going to be replaced by virtualized appliances
45 the service levels, manageability and service assurance needs to remain
46 consistent or improve on what is available today. As such, the NFVI needs to
47 support the ability to monitor:
48
49 * Traffic monitoring and performance monitoring of the components that provide
50   networking functionality to the VNF, including: physical interfaces, virtual
51   switch interfaces and flows, as well as the virtual interfaces themselves and
52   their status, etc.
53 * Platform monitoring including: CPU, memory, load, cache, themals, fan speeds,
54   voltages and machine check exceptions, etc.
55
56 All of the statistics and events gathered must be collected in-service and must
57 be capable of being reported by standard Telco mechanisms (e.g. SNMP), for
58 potential enforcement or correction actions. In addition, this information
59 could be fed to analytics systems to enable failure prediction, and can also be
60 used for intelligent workload placement.
61
62 All developed features will be upstreamed to Open Source projects relevant to
63 telemetry such as `collectd`_, and relevant Openstack projects.
64
65 .. toctree::
66      :maxdepth: 3
67
68      ./release/configguide/index.rst
69      ./release/scenarios/index.rst
70      ./release/userguide/index.rst
71      ./release/release-notes/index.rst
72      ./development/requirements/index.rst
73      ./development/design/index.rst
74      ./development/testing/index.rst
75
76 Indices
77 =======
78 * :ref:`search`
79
80 .. _Barometer: https://wiki.anuket.io/display/HOME/Barometer
81 .. _collectd: https://collectd.org/
82