diff options
Diffstat (limited to 'docs/release-notes')
| -rw-r--r-- | docs/release-notes/index.rst | 14 | ||||
| -rw-r--r-- | docs/release-notes/nfvbench-release-notes.rst | 147 | ||||
| -rw-r--r-- | docs/release-notes/nfvbenchvm-release-notes.rst | 94 |
3 files changed, 255 insertions, 0 deletions
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst new file mode 100644 index 0000000..827c674 --- /dev/null +++ b/docs/release-notes/index.rst @@ -0,0 +1,14 @@ +.. _nfvbench-releasenotes: + +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +************* +Release Notes +************* + +.. toctree:: + :maxdepth: 1 + + nfvbench-release-notes + nfvbenchvm-release-notes diff --git a/docs/release-notes/nfvbench-release-notes.rst b/docs/release-notes/nfvbench-release-notes.rst new file mode 100644 index 0000000..c1c52d4 --- /dev/null +++ b/docs/release-notes/nfvbench-release-notes.rst @@ -0,0 +1,147 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) Cisco Systems, Inc + +NFVbench Release Notes +++++++++++++++++++++++ + +Release 3.6.2 +============= + +- NFVBENCH-152 Add service_mode method for debugging purpose +- NFVBENCH-150 Add support for VXLAN latency +- NFVBENCH-146 Add cache_size option +- NFVBENCH-151 Allocate hugepages on two NUMAs in nfvbenchvm +- NFVBENCH-149 Negative latency exception during NDR/PDR search +- NFVBENCH-148 Increase the waiting time based on # of instances + +Release 3.5.1 +============= + +- NFVBENCH-147 Incorrect URL used for admin check in credentials +- Release the validation check for VxLAN networks +- NFVBENCH-145 Config file not found. No explicit error +- NFVBENCH-144 Trex cannot take account NFVBench config (platform thread id 0) + +- NFVBENCH-140 Retrieve High Dynamic Range latency histograms with TRex v2.59 +- NFVBENCH-143 Trex cannot start due to invalid config (platform None) +- NFVBENCH-141 Fix Openstack user admin role check +- NFVBENCH-139 Fix master_thread_id and latency_thread_id property checking +- NFVBENCH-95 Add HdrHistogram encodes returned by TRex to JSON results +- NFVBENCH-138 Use yaml.safe_load() instead of unsafe yaml load +- NFVBENCH-137 NFVbench generates wrong L4 checksums for VxLAN traffic + +Release 3.4.0 +============= + +- Add L3 traffic management with Neutron routers + + +Release 3.3.0 +============= + +Major release highlights: + +- VxLAN support +- test VM can now have idle interfaces +- test VM can be launched with multiqueue enabled +- upgrade to TRex v2.56 + + +Release 2.0 +=========== +NFVbench will now follow its own project release numbering (x.y.z) which is independent of the OPNFV release numbering (opnfv-x.y.z) + +Major release highlights: + +- Dedicated edge networks for each chain +- Enhanced chain analysis +- Code refactoring and enhanced unit testing +- Miscellaneous enhancement + +Dedicated edge networks for each chain +-------------------------------------- +NFVbench 1.x only supported shared edge networks for all chains. +For example, 20xPVP would create only 2 edge networks (left and right) shared by all chains. +With NFVbench 2.0, chain networks are dedicated (unshared) by default with an option in +the nfvbench configuration to share them. A 20xPVP run will create 2x20 networks instead. + +Enhanced chain analysis +----------------------- +The new chain analysis improves at multiple levels: + +- there is now one table for each direction (forward and reverse) that both read from left to right +- per-chain packet counters and latency +- all-chain aggregate packet counters and latency +- supports both shared and dedicated chain networks + +Code refactoring and enhanced unit testing +------------------------------------------ +The overall code structure is now better partitioned in the following functions: + +- staging and resource discovery +- traffic generator +- stats collection + +The staging algorithm was rewritten to be: + +- a lot more robust to errors and to handle better resource reuse use cases. + For example when a network with a matching name is discovered the new code will verify that the + network is associated to the right VM instance +- a lot more strict when it comes to the inventory of MAC addresses. For example the association + from each VM MAC to a chain index for each Trex port is handled in a much more strict manner. + +Although not all code is unit tested, the most critical parts are unit tested with the use of +the mock library. The resulting unit test code can run in isolation without needing a real system under test. + + +OPNFV Fraser Release +==================== + +Over 30 Jira tickets have been addressed in this release (Jira NFVBENCH-55 to NFVBENCH-78) + +The Fraser release adds the following new features: + +- support for benchmarking non-OpenStack environments (with external setup and no OpenStack openrc file) +- PVVP packet path with SRIOV at the edge and vswitch between VMs +- support logging events and results through fluentd + +Enhancements and main bug fixes: + +- end to end connectivity for larger chain count is now much more accurate for large chain count - avoiding excessive drops +- use newer version of TRex (2.32) +- use newer version of testpmd DPDK +- NDR/PDR uses actual TX rate to calculate drops - resulting in more accurate results +- add pylint to unit testing +- add self sufficient and standalone unit testing (without actual testbed) + + +OPNFV Euphrates Release +======================= + +This is the introductory release for NFVbench. In this release, NFVbench provides the following features/capabilities: + +- standalone installation with a single Docker container integrating the open source TRex traffic generator +- can measure data plane performance for any NFVi full stack +- can setup automatically service chains with the following packet paths: + - PVP (physical-VM-physical) + - PVVP (physical-VM-VM-physical) intra-node and inter-node +- can setup multiple service chains + - N * PVP + - N * PVVP +- supports any external service chain (pre-set externally) that can do basic IPv4 routing +- can measure + - drop rate and latency for any given fixed rate + - NDR (No Drop Rate) and PDR (Partial Drop Rate) with configurable drop rates +- traffic specification + - any fixed frame size or IMIX + - uni or bidirectional traffic + - any number of flows + - vlan tagging can be enabled or disabled +- user interface: + - CLI + - REST+socketIO +- fully configurable runs with yaml-JSON configuration +- detailed results in JSON format +- summary tabular results +- can send logs and results to one or more fluentd aggregators (per configuration) diff --git a/docs/release-notes/nfvbenchvm-release-notes.rst b/docs/release-notes/nfvbenchvm-release-notes.rst new file mode 100644 index 0000000..234a086 --- /dev/null +++ b/docs/release-notes/nfvbenchvm-release-notes.rst @@ -0,0 +1,94 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + + +NFVbench Loop VM Image Release Notes +++++++++++++++++++++++++++++++++++++ + +As explained in :ref:`nfvbench-artefact-versioning`, NFVbench loop VM image has +its own version numbering scheme. Starting from version 0.11, this page +summarizes the news of each release. + + +Release 0.16 (2022-11-15) +========================= + +Fixes: + +- Increase wait for VPP service from 10 to 30 seconds (10s is not enough on some + setups) and poll every second instead of sleeping 10s. + +- Set the MTU of the management interface to 1500 by default (to reduce the risk + to get an unmanageable VM). A different value can be set using the + ``INTF_MGMT_MTU`` variable in ``/etc/nfvbenchvm.conf``. + +Changes for developers: + +- Add 2 debug features to ``build-image.sh``: + + - The new option ``-t`` (enable debug traces) allows to show in the build log + the commands run in the shell scripts, including the commands defined in the + disk image builder elements. + + - The new option ``-d`` (debug) instructs ``disk-image-create`` to drop the + developer in a shell inside the chroot in case an error occurs. This makes + troubleshooting of the image possible (inspect files, run commands, ...) + +- Abort build on error: make sure a VM image build fails if any step fails. + Else we can end up with a bad image not containing all that we want, and we + discover this later at run time. + +- Fix build with diskimage_builder (dib) 3.16.0. + +- Switch VPP package repository to packagecloud.io instead of nexus.fd.io. This + fixes intermittent access issues with nexus.fd.io and this will make it + possible to get vpp releases higher than 19.08. + +- Separate loop VM and generator VM version numbers (a first step towards using + nfvbench version number for the generator VM). + + +Release 0.15 (2021-06-04) +========================= + +- NFVBENCH-211 Fix VPP driver for loop VM (switch UIO driver for VPP forwarder: + use ``uio_pci_generic`` instead of ``igb_uio``). + + +Release 0.14 (2021-05-21) +========================= + +- NFVBENCH-209 Fix NFVbench loopvm build failed on testpmd step (includes switch + UIO driver for testmpd forwarder: use ``uio_pci_generic`` instead of + ``igb_uio``). + + +Release 0.13 (2021-04-28) +========================= + +- NFVBENCH-196: New NFVbench image for generator part (nfvbench and TRex codes inside VM) +- Change Linux kernel boot-time configuration (kernel CLI parameters): + + - Extend CPU isolation (``isolcpus=1-7`` instead of ``isolcpus=1``) + - Increase the number of 1GB huge pages (``hugepages=4`` instead of ``hugepages=2``) + - Enable IOMMU (``intel_iommu=on iommu=pt``) + +- Load the ``vfio-pci`` kernel module with the ``enable_unsafe_noiommu_mode=1`` option. + + +Release 0.12 (2020-01-23) +========================= + +- NFVBENCH-157 Add possibility to not use the ARP static configuration for VPP loop VM + + +Release 0.11 (2019-11-26) +========================= + +- NFVBENCH-156 Add management interface and ssh config in NFVBench image + + +Earlier releases +================ + +See NFVbench commit history. |