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