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 REST       |
  42 |                                                      | server in the container (or use any appropriate      |
  43 |                                                      | docker network mode other than "host")               |
  44 +------------------------------------------------------+------------------------------------------------------+
  45 | --privilege                                          | (optional) required if SELinux is enabled on the host|
  46 +------------------------------------------------------+------------------------------------------------------+
  47
  48 It can be convenient to write a shell script (or an alias) to automatically insert the necessary options.
  49
  50 3. Start the Docker container
  51 -----------------------------
  52 As for any Docker container, you can execute NFVbench measurement sessions using a temporary container ("docker run" - which exits after each NFVbench run)
  53 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").
  54
  55 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).
  56 The second approach is more responsive as the delay is only incurred once when starting the container.
  57
  58 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)
  59
  60 .. code-block:: bash
  61
  62     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
  63
  64 The tail command simply prevents the container from exiting.
  65
  66 The create an alias to make it easy to execute nfvbench commands directly from the host shell prompt:
  67
  68 .. code-block:: bash
  69
  70     alias nfvbench='docker exec -it nfvbench nfvbench'
  71
  72 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.
  73
  74 To verify it is working:
  75
  76 .. code-block:: bash
  77
  78     nfvbench --version
  79     nfvbench --help
  80
  81
  82 4. NFVbench configuration
  83 -------------------------
  84
  85 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:
  86
  87 .. code-block:: bash
  88
  89   openrc_file:
  90   traffic_generator:
  91       generator_profile:
  92           - name: trex-local
  93             tool: TRex
  94             ip: 127.0.0.1
  95             cores: 3
  96             interfaces:
  97               - port: 0
  98                 switch_port:
  99                 pci:
 100               - port: 1
 101                 switch_port:
 102                 pci:
 103             intf_speed: 10Gbps
 104
 105 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
 106 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).
 107
 108 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:
 109
 110 .. code-block:: bash
 111
 112     [root@sjc04-pod6-build ~]# lspci | grep 710
 113     0a:00.0 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 114     0a:00.1 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 115     0a:00.2 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 116     0a:00.3 Ethernet controller: Intel Corporation Ethernet Controller X710 for 10GbE SFP+ (rev 01)
 117
 118
 119 Example of edited configuration with an OpenStack RC file stored in the current directory with the "openrc" name, and
 120 PCI addresses "0a:00.0" and "0a:00.1" (first 2 ports of the quad port NIC):
 121
 122 .. code-block:: bash
 123
 124   openrc_file: /tmp/nfvbench/openrc
 125   traffic_generator:
 126       generator_profile:
 127           - name: trex-local
 128             tool: TRex
 129             ip: 127.0.0.1
 130             cores: 3
 131             interfaces:
 132               - port: 0
 133                 switch_port:
 134                 pci: 0a:00.0
 135               - port: 1
 136                 switch_port:
 137                 pci: 0a:00.1
 138             intf_speed: 10Gbps
 139
 140 Alternatively, the full template with comments can be obtained using the --show-default-config option in yaml format:
 141
 142 .. code-block:: bash
 143
 144     nfvbench --show-default-config > my_nfvbench.cfg
 145
 146 Edit the nfvbench.cfg file to only keep those properties that need to be modified (preserving the nesting)
 147
 148
 149 5. Upload the NFVbench loopback VM image to OpenStack
 150 -----------------------------------------------------
 151 [TBP URL to NFVbench VM image in the OPNFV artifact repository]
 152
 153
 154 6. Run NFVbench
 155 ---------------
 156
 157 To do a single run at 10,000pps bi-directional (or 5kpps in each direction) using the PVP packet path:
 158
 159 .. code-block:: bash
 160
 161    nfvbench -c /tmp/nfvbench/my_nfvbench.cfg --rate 10kpps
 162
 163 NFVbench options used:
 164
 165 * ``-c /tmp/nfvbench/my_nfvbench.cfg`` : specify the config file to use (this must reflect the file path from inside the container)
 166 * ``--rate 10kpps`` : specify rate of packets for test for both directions using the kpps unit (thousands of packets per second)
 167
 168 This should produce a result similar to this (a simple run with the above options should take less than 5 minutes):
 169
 170 .. code-block:: none
 171
 172   [TBP]
 173
 174
 175 7. Terminating the NFVbench container
 176 -------------------------------------
 177 When no longer needed, the container can be terminated using the usual docker commands:
 178
 179 .. code-block:: bash
 180
 181     docker kill nfvbench
 182     docker rm nfvbench
 183