docs: add release information
[vswitchperf.git] / docs / release / NEWS.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) OPNFV, Intel Corporation, AT&T and others.
4
5 OPNFV Brahmaputra Release
6 =========================
7 Supports both OVS and OVS with DPDK.
8
9 Available tests:
10
11 * phy2phy_tput:     LTD.Throughput.RFC2544.PacketLossRatio
12 * back2back:        LTD.Throughput.RFC2544.BackToBackFrames
13 * phy2phy_tput_mod_vlan:LTD.Throughput.RFC2544.PacketLossRatioFrameModification
14 * phy2phy_cont:     Phy2Phy Continuous Stream
15 * pvp_cont:         PVP Continuous Stream
16 * pvvp_cont:        PVVP Continuous Stream
17 * phy2phy_scalability:LTD.Scalability.RFC2544.0PacketLoss
18 * pvp_tput:         LTD.Throughput.RFC2544.PacketLossRatio
19 * pvp_back2back:    LTD.Throughput.RFC2544.BackToBackFrames
20 * pvvp_tput:        LTD.Throughput.RFC2544.PacketLossRatio
21 * pvvp_back2back:   LTD.Throughput.RFC2544.BackToBackFrames
22 * phy2phy_cpu_load: LTD.CPU.RFC2544.0PacketLoss
23 * phy2phy_mem_load: LTD.Memory.RFC2544.0PacketLoss
24
25 Supported deployment scenarios:
26
27 * Physical port -> vSwitch -> Physical port.
28 * Physical port -> vSwitch -> VNF -> vSwitch -> Physical port.
29 * Physical port -> vSwitch -> VNF -> vSwitch -> VNF -> vSwitch -> Physical port.
30
31 Loopback applications in the Guest can be:
32
33 * DPDK testpmd.
34 * Linux Bridge.
35 * l2fwd Kernel Module.
36
37 Supported traffic generators:
38
39 * Ixia: IxOS and IxNet.
40 * Spirent.
41 * Dummy.
42
43 Release Data
44 ~~~~~~~~~~~~
45
46 +--------------------------------------+--------------------------------------+
47 | **Project**                          | vswitchperf                          |
48 |                                      |                                      |
49 +--------------------------------------+--------------------------------------+
50 | **Repo/tag**                         | brahmaputra.1.0                      |
51 |                                      |                                      |
52 +--------------------------------------+--------------------------------------+
53 | **Release designation**              | Brahmaputra base release             |
54 |                                      |                                      |
55 +--------------------------------------+--------------------------------------+
56 | **Release date**                     | February 26 2016                     |
57 |                                      |                                      |
58 +--------------------------------------+--------------------------------------+
59 | **Purpose of the delivery**          | Brahmaputra base release             |
60 |                                      |                                      |
61 +--------------------------------------+--------------------------------------+
62
63 November 2015
64 ==============
65
66 - Support of opnfv_test_dashboard
67
68 October 2015
69 ==============
70
71 - Support of PVP and PVVP deployment scenarios using Vanilla OVS
72
73 September 2015
74 ==============
75
76 - Implementation of system statistics based upon pidstat command line tool.
77 - Support of PVVP deployment scenario using bhost-cuse and vhost user access
78   methods
79
80 August 2015
81 ===========
82
83 - Backport and enhancement of reporting
84 - PVP deployment scenario testing using vhost-cuse as guest access method
85 - Implementation of LTD.Scalability.RFC2544.0PacketLoss testcase
86 - Support for background load generation with command line tools like stress
87   and stress-ng
88
89 July 2015
90 =========
91
92 - PVP deployment scenario testing using vhost-user as guest access method
93   - Verified on CentOS7 and Fedora 20
94   - Requires QEMU 2.2.0 and DPDK 2.0
95
96 May 2015
97 ========
98
99 This is the initial release of a re-designed version of the software
100 based on community feedback. This initial release supports only the
101 Phy2Phy deployment scenario and the
102 LTD.Throughput.RFC2544.PacketLossRatio test - both described in the
103 OPNFV vswitchperf 'CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE
104 CASES LEVEL TEST DESIGN'. The intention is that more test cases will
105 follow once the community has digested the initial release.
106
107 -  Performance testing with continuous stream
108 -  Vanilla OVS support added.
109
110    -  Support for non-DPDK OVS build.
111    -  Build and installation support through Makefile will be added via
112       next patch(Currently it is possible to manually build ovs and
113       setting it in vsperf configuration files).
114    -  PvP scenario is not yet implemented.
115
116 -  CentOS7 support
117 -  Verified on CentOS7
118 -  Install & Quickstart documentation
119
120 -  Better support for mixing tests types with Deployment Scenarios
121 -  Re-work based on community feedback of TOIT
122 -  Framework support for other vSwitches
123 -  Framework support for non-Ixia traffic generators
124 -  Framework support for different VNFs
125 -  Python3
126 -  Support for biDirectional functionality for ixnet interface
127
128 Missing
129 -------
130
131 -  xmlunit output is currently disabled