nfvbenchvm: release 0.16
[nfvbench.git] / docs / release / release-notes / nfvbenchvm-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
4
5 NFVbench Loop VM Image Release Notes
6 ++++++++++++++++++++++++++++++++++++
7
8 As explained in :ref:`nfvbench-artefact-versioning`, NFVbench loop VM image has
9 its own version numbering scheme.  Starting from version 0.11, this page
10 summarizes the news of each release.
11
12
13 Release 0.16 (2022-11-15)
14 =========================
15
16 Fixes:
17
18 - Increase wait for VPP service from 10 to 30 seconds (10s is not enough on some
19   setups) and poll every second instead of sleeping 10s.
20
21 - Set the MTU of the management interface to 1500 by default (to reduce the risk
22   to get an unmanageable VM).  A different value can be set using the
23   ``INTF_MGMT_MTU`` variable in ``/etc/nfvbenchvm.conf``.
24
25 Changes for developers:
26
27 - Add 2 debug features to ``build-image.sh``:
28
29   - The new option ``-t`` (enable debug traces) allows to show in the build log
30     the commands run in the shell scripts, including the commands defined in the
31     disk image builder elements.
32
33   - The new option ``-d`` (debug) instructs ``disk-image-create`` to drop the
34     developer in a shell inside the chroot in case an error occurs.  This makes
35     troubleshooting of the image possible (inspect files, run commands, ...)
36
37 - Abort build on error: make sure a VM image build fails if any step fails.
38   Else we can end up with a bad image not containing all that we want, and we
39   discover this later at run time.
40
41 - Fix build with diskimage_builder (dib) 3.16.0.
42
43 - Switch VPP package repository to packagecloud.io instead of nexus.fd.io.  This
44   fixes intermittent access issues with nexus.fd.io and this will make it
45   possible to get vpp releases higher than 19.08.
46
47 - Separate loop VM and generator VM version numbers (a first step towards using
48   nfvbench version number for the generator VM).
49
50
51 Release 0.15 (2021-06-04)
52 =========================
53
54 - NFVBENCH-211 Fix VPP driver for loop VM (switch UIO driver for VPP forwarder:
55   use ``uio_pci_generic`` instead of ``igb_uio``).
56
57
58 Release 0.14 (2021-05-21)
59 =========================
60
61 - NFVBENCH-209 Fix NFVbench loopvm build failed on testpmd step (includes switch
62   UIO driver for testmpd forwarder: use ``uio_pci_generic`` instead of
63   ``igb_uio``).
64
65
66 Release 0.13 (2021-04-28)
67 =========================
68
69 - NFVBENCH-196: New NFVbench image for generator part (nfvbench and TRex codes inside VM)
70 - Change Linux kernel boot-time configuration (kernel CLI parameters):
71
72   - Extend CPU isolation (``isolcpus=1-7`` instead of ``isolcpus=1``)
73   - Increase the number of 1GB huge pages (``hugepages=4`` instead of ``hugepages=2``)
74   - Enable IOMMU (``intel_iommu=on iommu=pt``)
75
76 - Load the ``vfio-pci`` kernel module with the ``enable_unsafe_noiommu_mode=1`` option.
77
78
79 Release 0.12 (2020-01-23)
80 =========================
81
82 - NFVBENCH-157 Add possibility to not use the ARP static configuration for VPP loop VM
83
84
85 Release 0.11 (2019-11-26)
86 =========================
87
88 - NFVBENCH-156 Add management interface and ssh config in NFVBench image
89
90
91 Earlier releases
92 ================
93
94 See NFVbench commit history.