.. code-block:: bash
- docker pull opnfv/nfvbench/nfvbench
+ docker pull opnfv/nfvbench
2. Docker Container configuration
---------------------------------
The NFVbench container requires the following Docker options to operate properly.
-+------------------------------------------------------+------------------------------------------------------+
-| Docker options | Description |
-+======================================================+======================================================+
-| -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) | needed by kernel modules in the container |
-+------------------------------------------------------+------------------------------------------------------+
-| -v /dev:/dev | needed by kernel modules in the container |
-+------------------------------------------------------+------------------------------------------------------+
-| -v $PWD:/tmp/nfvbench | optional but recommended to pass files between the |
-| | host and the docker space (see examples below) |
-| | Here we map the current directory on the host to the |
-| | /tmp/nfvbench director in the container but any |
-| | other similar mapping can work as well |
-+------------------------------------------------------+------------------------------------------------------+
-| --net=host | (optional) needed if you run the NFVbench REST |
-| | server in the container (or use any appropriate |
-| | docker network mode other than "host") |
-+------------------------------------------------------+------------------------------------------------------+
-| --privilege | (optional) required if SELinux is enabled on the host|
-+------------------------------------------------------+------------------------------------------------------+
++-------------------------------------------------------+-------------------------------------------------------+
+| Docker options | Description |
++=======================================================+=======================================================+
+| -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) | needed by kernel modules in the container |
++-------------------------------------------------------+-------------------------------------------------------+
+| -v /usr/src/kernels:/usr/src/kernels | needed by TRex to build kernel modules when needed |
++-------------------------------------------------------+-------------------------------------------------------+
+| -v /dev:/dev | needed by kernel modules in the container |
++-------------------------------------------------------+-------------------------------------------------------+
+| -v $PWD:/tmp/nfvbench | optional but recommended to pass files between the |
+| | host and the docker space (see examples below) |
+| | Here we map the current directory on the host to the |
+| | /tmp/nfvbench director in the container but any |
+| | other similar mapping can work as well |
++-------------------------------------------------------+-------------------------------------------------------+
+| --net=host | (optional) needed if you run the NFVbench ok |
+| | server in the container (or use any appropriate |
+| | docker network mode other than "host") |
++-------------------------------------------------------+-------------------------------------------------------+
+| --privileged | (optional) required if SELinux is enabled on the host |
++-------------------------------------------------------+-------------------------------------------------------+
+| -e HOST="127.0.0.1" | (optional) required if REST server is enabled |
++-------------------------------------------------------+-------------------------------------------------------+
+| -e PORT=7556 | (optional) required if REST server is enabled |
++-------------------------------------------------------+-------------------------------------------------------+
+| -e CONFIG_FILE="/root/nfvbenchconfig.json | (optional) required if REST server is enabled |
++-------------------------------------------------------+-------------------------------------------------------+
It can be convenient to write a shell script (or an alias) to automatically insert the necessary options.
+The minimal configuration file required must specify the openrc file to use (using in-container path), the PCI addresses of the 2 NIC ports to use
+for generating traffic and the line rate (in each direction) of each of these 2 interfaces.
+
+Here is an example of mimimal configuration where:
+the openrc file is located on the host current directory which is mapped under /tmp/nfvbench in the container (this is achieved using -v $PWD:/tmp/nfvbench)
+the 2 NIC ports to use for generating traffic have the PCI addresses "04:00.0" and "04:00.1"
+
+.. code-block:: bash
+
+ {
+ "openrc_file": "/tmp/nfvbench/openrc",
+ "traffic_generator": {
+ "generator_profile": [
+ {
+ "interfaces": [
+ {
+ "pci": "04:00.0",
+ "port": 0,
+ },
+ {
+ "pci": "04:00.1",
+ "port": 1,
+ }
+ ],
+ "intf_speed": "10Gbps",
+ "ip": "127.0.0.1",
+ "name": "trex-local",
+ "software_mode": false,
+ "tool": "TRex"
+ }
+ ]
+ }
+ }
+
+The other options in the minimal configuration must be present and must have the same values as above.
+
3. Start the Docker container
-----------------------------
As for any Docker container, you can execute NFVbench measurement sessions using a temporary container ("docker run" - which exits after each NFVbench run)
We will take the second approach and start the NFVbench container in detached mode with the name "nfvbench" (this works with bash, prefix with "sudo" if you do not use the root login)
+First create a new working directory, and change the current working directory to there. A "nfvbench_ws" directory under your home directory is good place for that, and this is where the OpenStack RC file and NFVbench config file will sit.
+
+To run NFVBench without server mode
+
.. code-block:: bash
- docker run --detach --net=host --privileged -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) --name nfvbench opnfv/nfvbench tail -f /dev/null
+ cd ~/nfvbench_ws
+ docker run --detach --net=host --privileged -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) -v /usr/src/kernels:/usr/src/kernels --name nfvbench opnfv/nfvbench
+
+To run NFVBench enabling REST server (mount the configuration json and the path for openrc)
+
+.. code-block:: bash
+
+ cd ~/nfvbench_ws
+ docker run --detach --net=host --privileged -e HOST="127.0.0.1" -e PORT=7556 --e CONFIG_FILE="/tmp/nfvbench/nfvbenchconfig.json -v $PWD:/tmp/nfvbench -v /dev:/dev -v /lib/modules/$(uname -r):/lib/modules/$(uname -r) -v /usr/src/kernels:/usr/src/kernels --name nfvbench opnfv/nfvbench start_rest_server
-The tail command simply prevents the container from exiting.
The create an alias to make it easy to execute nfvbench commands directly from the host shell prompt:
tool: TRex
ip: 127.0.0.1
cores: 3
+ software_mode: false,
interfaces:
- port: 0
switch_port:
tool: TRex
ip: 127.0.0.1
cores: 3
+ software_mode: false,
interfaces:
- port: 0
switch_port:
- pci: 0a:00.0
+ pci: "0a:00.0"
- port: 1
switch_port:
- pci: 0a:00.1
+ pci: "0a:00.1"
intf_speed: 10Gbps
+.. warning::
+
+ You have to put quotes around the pci addresses as shown in the above example, otherwise TRex will read it wrong.
+
Alternatively, the full template with comments can be obtained using the --show-default-config option in yaml format:
.. code-block:: bash
nfvbench --show-default-config > my_nfvbench.cfg
-Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting)
-
+Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting).
-5. Upload the NFVbench loopback VM image to OpenStack
------------------------------------------------------
-[TBP URL to NFVbench VM image in the OPNFV artifact repository]
+Make sure you have your nfvbench configuration file (my_nfvbench.cfg) and OpenStack RC file in your pre-created working directory.
-6. Run NFVbench
+5. Run NFVbench
---------------
To do a single run at 10,000pps bi-directional (or 5kpps in each direction) using the PVP packet path:
Code Review / nfvbench.git / blobdiff