2.0 beta NFVBENCH-91 Allow multi-chaining with separate edge networks
[nfvbench.git] / docs / release / release-notes / release-notes.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) Cisco Systems, Inc
4
5 RELEASE NOTES
6 +++++++++++++
7
8 Release 2.0
9 ===========
10 Major release highlights:
11
12 - Dedicated chain networks
13 - VxLAN support with VTEP in the traffic generator
14 - Enhanced chain analysis
15 - Code refactoring and enhanced unit testing
16 - Miscellaneous enhancement
17
18 Dedicated chain networks
19 ------------------------
20 NFVbench 1.x only supported shared networks across chains.
21 For example, 20xPVP would create only 2 networks (left and right) shared by all chains.
22 With NFVbench 2.0, chain networks will become dedicated (unshared) by default with an option in
23 the nfvbench configuration to shared them. A 20xPVP run will create 2x20 networks instead.
24
25 Enhanced chain analysis
26 -----------------------
27 The new chain analysis improves at multiple levels:
28
29 - there is now one table for each direction (forward and reverse) that both read from left to right
30 - per-chain packet counters and latency
31 - all-chain aggregate packet counters and latency
32 - supports both shared and dedicated chain networks
33
34 Code refactoring and enhanced unit testing
35 ------------------------------------------
36 The overall code structure is now better partitioned in the following functions:
37
38 - staging and resource discovery
39 - traffic generator
40 - stats collection
41
42 The staging algorithm was rewritten to be:
43
44 - a lot more robust to errors and to handle better resource reuse use cases.
45   For example when a network with a matching name is discovered the new code will verify that the
46   network is associated to the right VM instance
47 - a lot more strict when it comes to the inventory of MAC addresses. For example the association
48   from each VM MAC to a chain index for each Trex port is handled in a much more strict manner.
49
50 Although not all code is unit tested, the most critical parts are unit tested with the use of
51 the mock library. The resulting unit test code can run in isolation without needing a real system under test.
52
53
54 OPNFV Fraser Release
55 ====================
56
57 Over 30 Jira tickets have been addressed in this release (Jira NFVBENCH-55 to NFVBENCH-78)
58
59 The Fraser release adds the following new features:
60
61 - support for benchmarking non-OpenStack environments (with external setup and no OpenStack openrc file)
62 - PVVP packet path with SRIOV at the edge and vswitch between VMs
63 - support logging events and results through fluentd
64
65 Enhancements and main bug fixes:
66
67 - end to end connectivity for larger chain count is now much more accurate for large chain count - avoiding excessive drops
68 - use newer version of TRex (2.32)
69 - use newer version of testpmd DPDK
70 - NDR/PDR uses actual TX rate to calculate drops - resulting in more accurate results
71 - add pylint to unit testing
72 - add self sufficient and standalone unit testing (without actual testbed)
73
74
75 OPNFV Euphrates Release
76 =======================
77
78 This is the introductory release for NFVbench. In this release, NFVbench provides the following features/capabilities:
79
80 - standalone installation with a single Docker container integrating the open source TRex traffic generator
81 - can measure data plane performance for any NFVi full stack
82 - can setup automatically service chains with the following packet paths:
83     - PVP (physical-VM-physical)
84     - PVVP (physical-VM-VM-physical) intra-node and inter-node
85 - can setup multiple service chains
86     - N * PVP
87     - N * PVVP
88 - supports any external service chain (pre-set externally) that can do basic IPv4 routing
89 - can measure
90     - drop rate and latency for any given fixed rate
91     - NDR (No Drop Rate) and PDR (Partial Drop Rate) with configurable drop rates
92 - traffic specification
93     - any fixed frame size or IMIX
94     - uni or bidirectional traffic
95     - any number of flows
96     - vlan tagging can be enabled or disabled
97 - user interface:
98     - CLI
99     - REST+socketIO
100 - fully configurable runs with yaml-JSON configuration
101 - detailed results in JSON format
102 - summary tabular results
103 - can send logs and results to one or more fluentd aggregators (per configuration)