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