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/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 /dev:/dev                                         | needed by kernel modules in the container            |
  34 +------------------------------------------------------+------------------------------------------------------+
  35 | -v $PWD:/tmp/nfvbench                                | optional but recommended to pass files between the   |
  36 |                                                      | host and the docker space (see examples below)       |
  37 |                                                      | Here we map the current directory on the host to the |
  38 |                                                      | /tmp/nfvbench director in the container but any      |
  39 |                                                      | other similar mapping can work as well               |
  40 +------------------------------------------------------+------------------------------------------------------+
  41 | --net=host                                           | (optional) needed if you run the NFVbench ok         |
  42 |                                                      | server in the container (or use any appropriate      |
  43 |                                                      | docker network mode other than "host")               |
  44 +------------------------------------------------------+------------------------------------------------------+
  45 | --privileged                                         | (optional) required if SELinux is enabled on the host|
  46 +------------------------------------------------------+------------------------------------------------------+
  47 | -e HOST="127.0.0.1"                                  | (optional) required if REST server is enabled        |
  48 +------------------------------------------------------+------------------------------------------------------+
  49 | -e PORT=7556                                         | (optional) required if REST server is enabled        |
  50 +------------------------------------------------------+------------------------------------------------------+
  51 | -e CONFIG_FILE="/root/nfvbenchconfig.json            | (optional) required if REST server is enabled        |
  52 +------------------------------------------------------+------------------------------------------------------+
  53 It can be convenient to write a shell script (or an alias) to automatically insert the necessary options.
  54
  55 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
  56 for generating traffic and the line rate (in each direction) of each of these 2 interfaces.
  57
  58 Here is an example of mimimal configuration where:
  59 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)
  60 the 2 NIC ports to use for generating traffic have the PCI addresses "04:00.0" and "04:00.1"
  61
  62 .. code-block:: bash
  63     {
  64         "openrc_file": "/tmp/nfvbench/openrc",
  65         "traffic_generator": {
  66             "generator_profile": [
  67                 {
  68                     "interfaces": [
  69                         {
  70                             "pci": "04:00.0",
  71                             "port": 0,
  72                         },
  73                         {
  74                             "pci": "04:00.1",
  75                             "port": 1,
  76                         }
  77                     ],
  78                     "intf_speed": "10Gbps",
  79                     "ip": "127.0.0.1",
  80                     "name": "trex-local",
  81                     "tool": "TRex"
  82                 }
  83             ]
  84         }
  85     }
  86
  87 The other options in the minimal configuration must be present and must have the same values as above.
  88
  89 3. Start the Docker container
  90 -----------------------------
  91 As for any Docker container, you can execute NFVbench measurement sessions using a temporary container ("docker run" - which exits after each NFVbench run)
  92 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").
  93
  94 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).
  95 The second approach is more responsive as the delay is only incurred once when starting the container.
  96
  97 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)
  98
  99 To run NFVBench without server mode
 100
 101 .. code-block:: bash
 102
 103     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
 104
 105 To run NFVBench enabling REST server (mount the configuration json and the path for openrc)
 106
 107 .. code-block:: bash
 108
 109     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) --name nfvbench opnfv/nfvbench start_rest_server
 110
 111
 112 The create an alias to make it easy to execute nfvbench commands directly from the host shell prompt:
 113
 114 .. code-block:: bash
 115
 116     alias nfvbench='docker exec -it nfvbench nfvbench'
 117
 118 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.
 119
 120 To verify it is working:
 121
 122 .. code-block:: bash
 123
 124     nfvbench --version
 125     nfvbench --help
 126
 127
 128 4. NFVbench configuration
 129 -------------------------
 130
 131 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:
 132
 133 .. code-block:: bash
 134
 135   openrc_file:
 136   traffic_generator:
 137       generator_profile:
 138           - name: trex-local
 139             tool: TRex
 140             ip: 127.0.0.1
 141             cores: 3
 142             interfaces:
 143               - port: 0
 144                 switch_port:
 145                 pci:
 146               - port: 1
 147                 switch_port:
 148                 pci:
 149             intf_speed: 10Gbps
 150
 151 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
 152 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).
 153
 154 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:
 155
 156 .. code-block:: bash
 157
 158     [root@sjc04-pod6-build ~]# lspci | grep 710
 159     0a:00.0 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 160     0a:00.1 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 161     0a:00.2 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 162     0a:00.3 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 163
 164
 165 Example of edited configuration with an OpenStack RC file stored in the current directory with the "openrc" name, and
 166 PCI addresses "0a:00.0" and "0a:00.1" (first 2 ports of the quad port NIC):
 167
 168 .. code-block:: bash
 169
 170   openrc_file: /tmp/nfvbench/openrc
 171   traffic_generator:
 172       generator_profile:
 173           - name: trex-local
 174             tool: TRex
 175             ip: 127.0.0.1
 176             cores: 3
 177             interfaces:
 178               - port: 0
 179                 switch_port:
 180                 pci: 0a:00.0
 181               - port: 1
 182                 switch_port:
 183                 pci: 0a:00.1
 184             intf_speed: 10Gbps
 185
 186 Alternatively, the full template with comments can be obtained using the --show-default-config option in yaml format:
 187
 188 .. code-block:: bash
 189
 190     nfvbench --show-default-config > my_nfvbench.cfg
 191
 192 Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting)
 193
 194
 195 5. Run NFVbench
 196 ---------------
 197
 198 To do a single run at 10,000pps bi-directional (or 5kpps in each direction) using the PVP packet path:
 199
 200 .. code-block:: bash
 201
 202    nfvbench -c /tmp/nfvbench/my_nfvbench.cfg --rate 10kpps
 203
 204 NFVbench options used:
 205
 206 * ``-c /tmp/nfvbench/my_nfvbench.cfg`` : specify the config file to use (this must reflect the file path from inside the container)
 207 * ``--rate 10kpps`` : specify rate of packets for test for both directions using the kpps unit (thousands of packets per second)
 208
 209 This should produce a result similar to this (a simple run with the above options should take less than 5 minutes):
 210
 211 .. code-block:: none
 212
 213   [TBP]
 214
 215
 216 7. Terminating the NFVbench container
 217 -------------------------------------
 218 When no longer needed, the container can be terminated using the usual docker commands:
 219
 220 .. code-block:: bash
 221
 222     docker kill nfvbench
 223     docker rm nfvbench
 224