7 FD.io VPP software data plane technology has become very popular across
8 a wide range of VPP eco-system use cases, putting higher pressure on
9 continuous verification of VPP software quality.
11 This document describes a proposal for design and implementation of extended
12 continuous VPP testing by extending existing test environments.
13 Furthermore it describes and summarizes implementation details of Integration
14 and System tests platform *1-Node VPP_Device*. It aims to provide a complete
15 end-to-end view of *1-Node VPP_Device* environment in order to improve
16 extendibility and maintenance, under the guideline of VPP core team.
18 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD",
19 "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be
20 interpreted as described in :rfc:`8174`.
25 .. todo: Covert to SVG
27 .. image:: vpp-device.png
32 All :abbr:`FD.io (Fast Data Input/Ouput)` :abbr:`CSIT (Continuous System
33 Integration and Testing)` vpp-device tests are executed on physical testbeds
34 built with bare-metal servers hosted by :abbr:`LF (Linux Foundation)` FD.io
35 project. Two 1-node testbed topologies are used:
37 - **2-Container Topology**: Consisting of one Docker container acting as SUT
38 (System Under Test) and one Docker container as TG (Traffic Generator), both
39 connected in ring topology via physical NIC crossconnecting.
41 Current FD.io production testbeds are built with servers based on one
42 processor generation of Intel Xeons: Skylake (Platinum 8180). Testbeds built
43 with servers based on Arm processors are in the process of being added to FD.io
46 Following section describe existing production 1n-skx testbed.
48 1-Node Xeon Skylake (1n-skx)
49 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51 1n-skx testbed is based on single SuperMicro SYS-7049GP-TRT server equipped with
52 two Intel Xeon Skylake Platinum 8180 2.5 GHz 28 core processors. Physical
53 testbed topology is depicted in a figure below.
61 \graphicspath{{../_tmp/src/vpp_device_tests/}}
62 \includegraphics[width=0.90\textwidth]{vf-2n-nic2nic}
63 \label{fig:vf-2n-nic2nic}
68 .. figure:: vf-2n-nic2nic.svg
72 Server is populated with the following NIC models:
74 #. NIC-1: x710-da4 4p10GE Intel.
75 #. NIC-2: x710-da4 4p10GE Intel.
77 All Intel Xeon Skylake servers run with Intel Hyper-Threading enabled,
78 doubling the number of logical cores exposed to Linux, with 56 logical
79 cores and 28 physical cores per processor socket.
81 NIC interfaces are shared using Linux vfio_pci and VPP VF drivers:
84 - Fortville AVF driver.
86 Provided Intel x710-da4 4p10GE NICs suppport 32 VFs per interface, 128 per NIC.
88 Complete 1n-skx testbeds specification is available on `CSIT LF Testbeds
89 <https://wiki.fd.io/view/CSIT/Testbeds:_Xeon_Skx,_Arm,_Atom.>`_ wiki page.
91 Total of two 1n-skx testbeds are in operation in FD.io labs.
93 1-Node Virtualbox (1n-vbox)
94 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
96 1n-skx testbed can run in single VirtualBox VM machine. This solution replaces
97 the previously used Vagrant environment based on 3 VMs.
99 VirtualBox VM MAY be created by Vagrant and MUST have additional 4 virtio NICs
100 each pair attached to separate private networks to simulate back-to-back
101 connections. It SHOULD be 82545EM device model (otherwise can be changed in
102 boostrap scripts). Example of Vagrant configuration:
106 Vagrant.configure(2) do |c|
107 c.vm.network "private_network", type: "dhcp", auto_config: false,
108 virtualbox__intnet: "port1", nic_type: "82545EM"
109 c.vm.network "private_network", type: "dhcp", auto_config: false,
110 virtualbox__intnet: "port2", nic_type: "82545EM"
112 c.vm.provider :virtualbox do |v|
113 v.customize ["modifyvm", :id, "--nicpromisc2", "allow-all"]
114 v.customize ["modifyvm", :id, "--nicpromisc3", "allow-all"]
115 v.customize ["modifyvm", :id, "--nicpromisc4", "allow-all"]
116 v.customize ["modifyvm", :id, "--nicpromisc5", "allow-all"]
118 Vagrant VM is populated with the following NIC models:
120 #. NIC-1: 82545EM Intel.
121 #. NIC-2: 82545EM Intel.
122 #. NIC-3: 82545EM Intel.
123 #. NIC-4: 82545EM Intel.
128 It was agreed on :abbr:`TWS (Technical Work Stream)` call to continue with
129 Ubuntu 18.04 LTS as a baseline system with OPTIONAL extend to Centos 7 and
130 SuSE per demand [TWSLink]_.
132 All :abbr:`DCR (Docker container)` images are REQUIRED to be hosted on Docker
133 registry available from LF network, publicly available and trackable. For
134 backup, tracking and contributing purposes all Dockerfiles (including files
135 needed for building container) MUST be available and stored in [fdiocsitgerrit]_
136 repository under appropriate folders. This allows the peer review process to be
137 done for every change of infrastructure related to scope of this document.
138 Currently only **csit-shim-dcr** and **csit-sut-dcr** containers will be stored
139 and maintained under CSIT repository by CSIT contributors.
141 At the time of designing solution described in this document the interconnection
142 between [dockerhub]_ and [fdiocsitgerrit]_ for automated build purposes and
143 image hosting cannot be established with the trust and respectful to
144 security of FD.io project. Unless adressed, :abbr:`DCR` images will be placed in
145 custom registry service [fdioregistry]_. Automated Jenkins jobs will be created
146 in align of long term solution for container lifecycle and ability to build
147 new version of docker images.
149 In parallel, the effort is started to find the outsourced Docker registry
155 As of initial version of vpp-device, we do have only single `:latest` version of
156 Docker image hosted on [dockerhub]_. This will be addressed as further
157 improvement with proper semantic versioning.
162 This :abbr:`DCR` acts as the Jenkins slave (known also as jenkins minion). It
163 can connect over SSH protocol to TCP port 6022 of **csit-shim-dcr** and executes
164 non-interactive reservation script. Nomad is responsible for scheduling this
165 container execution onto specific **1-Node VPP_Device** testbed. It executes
166 :abbr:`CSIT` environment including :abbr:`CSIT` framework.
168 All software dependencies including VPP/DPDK that are not present in
169 **csit-sut-dcr** container image and/or needs to be compiled prior running on
170 **csit-sut-dcr** SHOULD be compiled in this container.
172 - *Container Image Location*: Docker image at snergster/vpp-ubuntu18.
174 - *Container Definition*: Docker file specified at [JenkinsSlaveDcrFile]_.
176 - *Initializing*: Container is initialized from within *Consul by HashiCorp*
177 and *Nomad by HashiCorp*.
182 This :abbr:`DCR` acts as an intermediate layer running script responsible for
183 orchestrating topologies under test and reservation. Responsible for managing VF
184 resources and allocation to :abbr:`DUT (Device Under Test)`, :abbr:`TG
185 (Traffic Generator)` containers. This MUST to be done on **csit-shim-dcr**.
186 This image also acts as the generic reservation mechanics arbiter to make sure
187 that only Y number of simulations are spawned on any given HW node.
189 - *Container Image Location*: Docker image at snergster/csit-shim.
191 - *Container Definition*: Docker file specified at [CsitShimDcrFile]_.
193 - *Initializing*: Container is initialized from within *Consul by HashiCorp*
194 and *Nomad by HashiCorp*. Required docker parameters, to be able to run
195 nested containers with VF reservation system are: privileged, net=host,
198 - *Connectivity*: Over SSH only, using <host>:6022 format. Currently using
199 *root* user account as primary. From the jenkins slave it will be able to
200 connect via env variable, since the jenkins slave doesn't actually know what
203 ssh -p 6022 root@10.30.51.node
208 This :abbr:`DCR` acts as an :abbr:`SUT (System Under Test)`. Any :abbr:`DUT` or
209 :abbr:`TG` application is installed there. It is RECOMMENDED to install DUT and
210 all DUT dependencies via commands ``rpm -ihv`` on RedHat based OS or ``dpkg -i``
213 Container is designed to be a very lightweight Docker image that only installs
214 packages and execute binaries (previously built or downloaded on
215 **jenkins-slave-dcr**) and contains libraries necessary to run CSIT framework
216 including those required by DUT/TG.
218 - *Container Image Location*: Docker image at snergster/csit-sut.
220 - *Container Definition*: Docker file specified at [CsitSutDcrFile]_.
226 # Run the container in the background and print the new container ID.
228 # Give extended privileges to this container. A "privileged" container is
229 # given access to all devices and able to run nested containers.
231 # Publish all exposed ports to random ports on the host interfaces.
233 # Automatically remove the container when it exits.
237 # Override access to PCI bus by attaching a filesystem mount to the
239 --mount type=tmpfs,destination=/sys/bus/pci/devices
240 # Mount vfio to be able to bind to see binded interfaces. We cannot use
241 # --device=/dev/vfio as this does not see newly binded interfaces.
242 --volume /dev/vfio:/dev/vfio
243 # Image of csit-sut-dcr
244 snergster/csit-vpp-device-test:latest
246 Container name is catenated from **csit-** prefix and uuid generated uniquely
247 for each container instance.
249 - *Connectivity*: Over SSH only, using <host>[:<port>] format. Currently using
250 *root* user account as primary.
253 ssh -p <port> root@10.30.51.<node>
255 Container required to run as ``--privileged`` due to ability to create nested
256 containers and have full read/write access to sysfs (for bind/unbind). Docker
257 automatically pick free network port (``--publish-all``) for ability to connect
258 over ssh. To be able to limit access to PCI bus, container is creating tmpfs
259 mount type in PCI bus tree. CSIT reservation script is dynamically linking only
260 PCI devices (NIC cards) that are reserved for particular container. This
261 way it is not colliding with other containers. To make vfio work, access to
262 ``/dev/vfio`` must be granted.
264 .. todo: Change default user to testuser with non-privileged and install sudo.
266 Environment initialization
267 --------------------------
269 All 1-node servers are to be managed and provisioned via the [ansiblelink]_ set
270 of playbooks with *vpp-device* role. Full playbooks can be found under
271 [fdiocsitansible]_ directory. This way we are able to track all configuration
272 changes of physical servers in gerrit (in structured yaml format) as well as we
273 are able to extend *vpp-device* to additional servers with less effort or
274 re-stage servers in case of failure.
276 SR-IOV VF initialization is done via ``systemd`` service during host system boot
277 up. Service with name *csit-initialize-vfs.service* is created under systemd
278 system context (``/etc/systemd/system/``). By default service is calling
279 ``/usr/local/bin/csit-initialize-vfs.sh`` with single parameter:
281 - **start**: Creates maximum number of :abbr:`virtual functions (VFs)` (detected
282 from ``sriov_totalvfs``) for each whitelisted PCI device.
283 - **stop**: Removes all :abbr:`VFs` for all whitelisted PCI device.
285 Service is considered active even when all of its processes exited successfully.
286 Stopping service will automatically remove :abbr:`VFs`.
291 Description=CSIT Initialize SR-IOV VFs
297 ExecStart=/usr/local/bin/csit-initialize-vfs.sh start
298 ExecStop=/usr/local/bin/csit-initialize-vfs.sh stop
301 WantedBy=default.target
303 Script is driven by two array variables ``pci_blacklist``/``pci_whitelist``.
304 They MUST store all PCI addresses in **<domain>:<bus>:<device>.<func>** format,
307 - **pci_blacklist**: PCI addresses to be skipped from :abbr:`VFs`
308 initialization (usefull for e.g. excluding management network interfaces).
309 - **pci_whitelist**: PCI addresses to be included for :abbr:`VFs`
315 During topology initialization phase of script, mutex is used to avoid multiple
316 instances of script to interact with each other during resources allocation.
317 Mutal exclusion ensure that no two distinct instances of script will get same
320 Reservation function reads the list of all available virtual function network
325 net_path="/sys/bus/pci/devices/*/net/*"
328 $(find ${net_path} -type d -name . -o -prune -exec basename '{}' ';');
330 if grep -q "${pci_id}" "/sys/class/net/${netdev}/device/device"; then
335 Where ``${pci_id}`` is ID of white-listed VF PCI ID. For more information please
336 see [pciids]_. This act as security constraint to prevent taking other unwanted
338 The output list of all VF network devices is split into two lists for TG and
339 SUT side of connection. First two items from each TG or SUT network devices
340 list are taken to expose directly to namespace of container. This can be done
345 $ ip link set ${netdev} netns ${DCR_CPIDS[tg]}
346 $ ip link set ${netdev} netns ${DCR_CPIDS[dut1]}
348 In this stage also symbolic links to PCI devices under sysfs bus directory tree
349 are created in running containers. Once VF devices are assigned to container
350 namespace and PCI deivces are linked to running containers and mutex is exited.
351 Selected VF network device automatically dissapear from parent container
352 namespace, so another instance of script will not find device under that
355 Once Docker container exits, network device is returned back into parent
356 namespace and can be reused.
358 Network traffic isolation - Intel i40evf
359 ----------------------------------------
361 In a virtualized environment, on Intel(R) Server Adapters that support SR-IOV,
362 the virtual function (VF) may be subject to malicious behavior. Software-
363 generated layer two frames, like IEEE 802.3x (link flow control), IEEE 802.1Qbb
364 (priority based flow-control), and others of this type, are not expected and
365 can throttle traffic between the host and the virtual switch, reducing
366 performance. To resolve this issue, configure all SR-IOV enabled ports for
367 VLAN tagging. This configuration allows unexpected, and potentially malicious,
368 frames to be dropped. [inteli40e]_
370 To configure VLAN tagging for the ports on an SR-IOV enabled adapter,
371 use the following command. The VLAN configuration SHOULD be done
372 before the VF driver is loaded or the VM is booted. [inteli40e]_
376 $ ip link set dev <PF netdev id> vf <id> vlan <vlan id>
378 For example, the following instructions will configure PF eth0 and
379 the first VF on VLAN 10.
383 $ ip link set dev eth0 vf 0 vlan 10
385 VLAN Tag Packet Steering allows to send all packets with a specific VLAN tag to
386 a particular SR-IOV virtual function (VF). Further, this feature allows to
387 designate a particular VF as trusted, and allows that trusted VF to request
388 selective promiscuous mode on the Physical Function (PF). [inteli40e]_
390 To set a VF as trusted or untrusted, enter the following command in the
395 $ ip link set dev eth0 vf 1 trust [on|off]
397 Once the VF is designated as trusted, use the following commands in the VM
398 to set the VF to promiscuous mode. [inteli40e]_
400 - For promiscuous all:
403 $ ip link set eth2 promisc on
405 - For promiscuous Multicast:
408 $ ip link set eth2 allmulti on
412 By default, the ethtool priv-flag vf-true-promisc-support is set to
413 *off*, meaning that promiscuous mode for the VF will be limited. To set the
414 promiscuous mode for the VF to true promiscuous and allow the VF to see
415 all ingress traffic, use the following command.
416 $ ethtool set-priv-flags p261p1 vf-true-promisc-support on
417 The vf-true-promisc-support priv-flag does not enable promiscuous mode;
418 rather, it designates which type of promiscuous mode (limited or true)
419 you will get when you enable promiscuous mode using the ip link commands
420 above. Note that this is a global setting that affects the entire device.
421 However,the vf-true-promisc-support priv-flag is only exposed to the first
422 PF of the device. The PF remains in limited promiscuous mode (unless it
423 is in MFP mode) regardless of the vf-true-promisc-support setting.
426 Service described earlier *csit-initialize-vfs.service* is responsible for
427 assigning 802.1Q vlan tagging to each vitual function via physical function
428 from list of white-listed PCI addresses by following (simplified) code.
433 for pci_addr in ${pci_whitelist[@]}; do
434 pci_path="/sys/bus/pci/devices/${pci_addr}"
435 pf=$(basename "${pci_path}"/net/*)
436 for vf in $(seq "${sriov_totalvfs}"); do
437 # PCI address index in array (pairing siblings).
438 vlan_pf_idx=$(( pci_idx % (${#pci_whitelist[@]} / 2) ))
439 # 802.1Q base offset.
441 # 802.1Q PF PCI address offset.
442 vlan_pf_off=$(( vlan_pf_idx * 100 + vlan_bs_off ))
443 # 802.1Q VF PCI address offset.
444 vlan_vf_off=$(( vlan_pf_off + vf - 1 ))
446 vlan_str="vlan ${vlan_vf_off}"
448 mac5="$(printf '%x' ${pci_idx})"
449 mac6="$(printf '%x' $(( vf - 1 )))"
450 mac_str="mac ba:dc:0f:fe:${mac5}:${mac6}"
451 # Set 802.1Q VLAN id and MAC address
452 ip link set ${pf} vf $(( vf - 1 )) ${mac_str} ${vlan_str}
453 ip link set ${pf} vf $(( vf - 1 )) trust on
454 ip link set ${pf} vf $(( vf - 1 )) spoof off
456 pci_idx=$(( pci_idx + 1 ))
459 Assignment starts at VLAN 1100 and incrementing by 1 for each VF and by 100 for
460 each white-listed PCI address up to the middle of the PCI list. Second half of
461 the lists is assumed to be directly (cable) paired siblings and assigned with
462 same 802.1Q VLANs as its siblings.
472 Switch to non-privileged containers: As of now all three container
473 flavors are using privileged containers to make it working. Explore options
474 to switch containers to non-privileged with explicit rather implicit
479 Switch to testuser account intead of root.
486 Docker image distribution: Create jenkins jobs with full pipiline of
487 CI/CD for CSIT Docker images.
494 Improve NIC selection pair-wise: As of now script is taking first two
495 interfaces from discovered list regardless of sibling pairing. Implement
496 more advance method of selection of interfaces based on VF 802.1Q siblings.
500 Implement queueing mechanism: Currently there is no mechanics that
501 would place starving jobs in queue in case of no resources available.
505 Replace reservation script with Docker network plugin written in
506 GOLANG/SH/Python - platform independent.
511 .. [TWSLink] `TWS <https://wiki.fd.io/view/CSIT/TWS>`_
512 .. [dockerhub] `Docker hub <https://hub.docker.com/>`_
513 .. [fdiocsitgerrit] `FD.io/CSIT gerrit <https://gerrit.fd.io/r/CSIT>`_
514 .. [fdioregistry] `FD.io registy <registry.fdiopoc.net>`_
515 .. [JenkinsSlaveDcrFile] `jenkins-slave-dcr-file <https://github.com/snergfdio/multivppcache/blob/master/ubuntu18/Dockerfile>`_
516 .. [CsitShimDcrFile] `csit-shim-dcr-file <https://github.com/snergfdio/multivppcache/blob/master/csit-shim/Dockerfile>`_
517 .. [CsitSutDcrFile] `csit-sut-dcr-file <https://github.com/snergfdio/multivppcache/blob/master/csit-sut/Dockerfile>`_
518 .. [ansiblelink] `ansible <https://www.ansible.com/>`_
519 .. [fdiocsitansible] `Fd.io/CSIT ansible <https://git.fd.io/csit/tree/resources/tools/testbed-setup/ansible>`_
520 .. [inteli40e] `Intel i40e <https://downloadmirror.intel.com/26370/eng/readme.txt>`_
521 .. [pciids] `pci ids <http://pci-ids.ucw.cz/v2.2/pci.ids>`_