docs/testing/user/userguide/quickstart_docker.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. (c) Cisco Systems, Inc
   4
   5 ===========================================
   6 NFVbench Installation and Quick Start Guide
   7 ===========================================
   8
   9 .. _docker_installation:
  10
  11 Make sure you satisfy the `hardware and software requirements <requirements>` before you start .
  12
  13
  14 1. Container installation
  15 -------------------------
  16
  17 To pull the latest NFVbench container image:
  18
  19 .. code-block:: bash
  20
  21     docker pull opnfv/nfvbench
  22
  23 2. Docker Container configuration
  24 ---------------------------------
  25
  26 The NFVbench container requires the following Docker options to operate properly.
  27
  28 +-------------------------------------------------------+-------------------------------------------------------+
  29 | Docker options                                        | Description                                           |
  30 +=======================================================+=======================================================+
  31 | -v /lib/modules/$(uname -r):/lib/modules/$(uname -r)  | needed by kernel modules in the container             |
  32 +-------------------------------------------------------+-------------------------------------------------------+
  33 | -v /usr/src/kernels:/usr/src/kernels                  | needed by TRex to build kernel modules when needed    |
  34 +-------------------------------------------------------+-------------------------------------------------------+
  35 | -v /dev:/dev                                          | needed by kernel modules in the container             |
  36 +-------------------------------------------------------+-------------------------------------------------------+
  37 | -v $PWD:/tmp/nfvbench                                 | optional but recommended to pass files between the    |
  38 |                                                       | host and the docker space (see examples below)        |
  39 |                                                       | Here we map the current directory on the host to the  |
  40 |                                                       | /tmp/nfvbench director in the container but any       |
  41 |                                                       | other similar mapping can work as well                |
  42 +-------------------------------------------------------+-------------------------------------------------------+
  43 | --net=host                                            | (optional) needed if you run the NFVbench             |
  44 |                                                       | server in the container (or use any appropriate       |
  45 |                                                       | docker network mode other than "host")                |
  46 +-------------------------------------------------------+-------------------------------------------------------+
  47 | --privileged                                          | (optional) required if SELinux is enabled on the host |
  48 +-------------------------------------------------------+-------------------------------------------------------+
  49 | -e HOST="127.0.0.1"                                   | (optional) required if REST server is enabled         |
  50 +-------------------------------------------------------+-------------------------------------------------------+
  51 | -e PORT=7556                                          | (optional) required if REST server is enabled         |
  52 +-------------------------------------------------------+-------------------------------------------------------+
  53 | -e CONFIG_FILE="/root/nfvbenchconfig.json             | (optional) required if REST server is enabled         |
  54 +-------------------------------------------------------+-------------------------------------------------------+
  55
  56 It can be convenient to write a shell script (or an alias) to automatically insert the necessary options.
  57
  58 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
  59 for generating traffic and the line rate (in each direction) of each of these 2 interfaces.
  60
  61 Here is an example of mimimal configuration where:
  62 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)
  63 the 2 NIC ports to use for generating traffic have the PCI addresses "04:00.0" and "04:00.1"
  64
  65 .. code-block:: bash
  66
  67     {
  68         "openrc_file": "/tmp/nfvbench/openrc",
  69         "traffic_generator": {
  70             "generator_profile": [
  71                 {
  72                     "interfaces": [
  73                         {
  74                             "pci": "04:00.0",
  75                             "port": 0,
  76                         },
  77                         {
  78                             "pci": "04:00.1",
  79                             "port": 1,
  80                         }
  81                     ],
  82                     "intf_speed": "",
  83                     "ip": "127.0.0.1",
  84                     "name": "trex-local",
  85                     "software_mode": false,
  86                     "tool": "TRex"
  87                 }
  88             ]
  89         }
  90     }
  91
  92 The other options in the minimal configuration must be present and must have the same values as above.
  93
  94 3. Start the Docker container
  95 -----------------------------
  96 As for any Docker container, you can execute NFVbench measurement sessions using a temporary container ("docker run" - which exits after each NFVbench run)
  97 or you can decide to run the NFVbench container in the background then execute one or more NFVbench measurement sessions on that container ("docker exec").
  98
  99 The former approach is simpler to manage (since each container is started and terminated after each command) but incurs a small delay at start time (several seconds).
 100 The second approach is more responsive as the delay is only incurred once when starting the container.
 101
 102 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)
 103
 104 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.
 105
 106 To run NFVBench without server mode
 107
 108 .. code-block:: bash
 109
 110     cd ~/nfvbench_ws
 111     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
 112
 113 To run NFVBench enabling REST server (mount the configuration json and the path for openrc)
 114
 115 .. code-block:: bash
 116
 117     cd ~/nfvbench_ws
 118     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
 119
 120
 121 The create an alias to make it easy to execute nfvbench commands directly from the host shell prompt:
 122
 123 .. code-block:: bash
 124
 125     alias nfvbench='docker exec -it nfvbench nfvbench'
 126
 127 The next to last "nfvbench" refers to the name of the container while the last "nfvbench" refers to the NFVbench binary that is available to run in the container.
 128
 129 To verify it is working:
 130
 131 .. code-block:: bash
 132
 133     nfvbench --version
 134     nfvbench --help
 135
 136
 137 4. NFVbench configuration
 138 -------------------------
 139
 140 Create a new file containing the minimal configuration for NFVbench, we can call it any name, for example "my_nfvbench.cfg" and paste the following yaml template in the file:
 141
 142 .. code-block:: bash
 143
 144   openrc_file:
 145   traffic_generator:
 146       generator_profile:
 147           - name: trex-local
 148             tool: TRex
 149             ip: 127.0.0.1
 150             cores: 3
 151             software_mode: false,
 152             interfaces:
 153               - port: 0
 154                 switch_port:
 155                 pci:
 156               - port: 1
 157                 switch_port:
 158                 pci:
 159             intf_speed:
 160
 161 NFVbench requires an ``openrc`` file to connect to OpenStack using the OpenStack API. This file can be downloaded from the OpenStack Horizon dashboard (refer to the OpenStack documentation on how to
 162 retrieve the openrc file). The file pathname in the container must be stored in the "openrc_file" property. If it is stored on the host in the current directory, its full pathname must start with /tmp/nfvbench (since the current directory is mapped to /tmp/nfvbench in the container).
 163
 164 The required configuration is the PCI address of the 2 physical interfaces that will be used by the traffic generator. The PCI address can be obtained for example by using the "lspci" Linux command. For example:
 165
 166 .. code-block:: bash
 167
 168     [root@sjc04-pod6-build ~]# lspci | grep 710
 169     0a:00.0 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 170     0a:00.1 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 171     0a:00.2 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 172     0a:00.3 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 173
 174
 175 Example of edited configuration with an OpenStack RC file stored in the current directory with the "openrc" name, and
 176 PCI addresses "0a:00.0" and "0a:00.1" (first 2 ports of the quad port NIC):
 177
 178 .. code-block:: bash
 179
 180   openrc_file: /tmp/nfvbench/openrc
 181   traffic_generator:
 182       generator_profile:
 183           - name: trex-local
 184             tool: TRex
 185             ip: 127.0.0.1
 186             cores: 3
 187             software_mode: false,
 188             interfaces:
 189               - port: 0
 190                 switch_port:
 191                 pci: "0a:00.0"
 192               - port: 1
 193                 switch_port:
 194                 pci: "0a:00.1"
 195             intf_speed:
 196
 197 .. warning::
 198
 199     You have to put quotes around the pci addresses as shown in the above example, otherwise TRex will read it wrong.
 200
 201 Alternatively, the full template with comments can be obtained using the --show-default-config option in yaml format:
 202
 203 .. code-block:: bash
 204
 205     nfvbench --show-default-config > my_nfvbench.cfg
 206
 207 Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting).
 208
 209 Make sure you have your nfvbench configuration file (my_nfvbench.cfg) and OpenStack RC file in your pre-created working directory.
 210
 211
 212 5. Run NFVbench
 213 ---------------
 214
 215 To do a single run at 10,000pps bi-directional (or 5kpps in each direction) using the PVP packet path:
 216
 217 .. code-block:: bash
 218
 219    nfvbench -c /tmp/nfvbench/my_nfvbench.cfg --rate 10kpps
 220
 221 NFVbench options used:
 222
 223 * ``-c /tmp/nfvbench/my_nfvbench.cfg`` : specify the config file to use (this must reflect the file path from inside the container)
 224 * ``--rate 10kpps`` : specify rate of packets for test for both directions using the kpps unit (thousands of packets per second)
 225
 226 This should produce a result similar to this (a simple run with the above options should take less than 5 minutes):
 227
 228 .. code-block:: none
 229
 230   [TBP]
 231
 232
 233 7. Terminating the NFVbench container
 234 -------------------------------------
 235 When no longer needed, the container can be terminated using the usual docker commands:
 236
 237 .. code-block:: bash
 238
 239     docker kill nfvbench
 240     docker rm nfvbench