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