VNFs/DPPD-PROX/helper-scripts/openstackrapid/README

   1 ##
   2 ## Copyright (c) 2010-2017 Intel Corporation
   3 ##
   4 ## Licensed under the Apache License, Version 2.0 (the "License");
   5 ## you may not use this file except in compliance with the License.
   6 ## You may obtain a copy of the License at
   7 ##
   8 ##     http://www.apache.org/licenses/LICENSE-2.0
   9 ##
  10 ## Unless required by applicable law or agreed to in writing, software
  11 ## distributed under the License is distributed on an "AS IS" BASIS,
  12 ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 ## See the License for the specific language governing permissions and
  14 ## limitations under the License.
  15 ##
  16
  17 rapid (Rapid Automated Performance Indication for Dataplane)
  18 ************************************************************
  19
  20 rapid is a set of files offering an easy way to do a sanity check of the
  21 dataplane performance of an OpenStack environment.
  22
  23 Copy the files in a directory on a machine that can run the OpenStack CLI
  24 commands and that can reach the OpenStack public network. Also create a qcow2
  25 image in the same directory with the following characteristics:
  26 * Name of the qcow2 file should be: rapidVM.qcow2
  27   This default name can be changed on the rapid command line
  28 * Should have DPDK and PROX installed. PROX should be in /root/prox/ directory
  29 * Image should have cloud-init installed
  30
  31 Source the openrc file of the OpenStack environment so that the OpenStack CLI
  32 commands can be run:
  33   # source openrc
  34 Now you can run the rapid.py file. Use help for more info on the usage:
  35   # ./rapid.py --help
  36
  37 rapid will use the OpenStack CLI to create the flavor, key-pair, network, image,
  38 stack, ...
  39 Then it will connect to the 2 VMs that have been instantiated and it will launch
  40 PROX in both VMs.
  41 Once that is done it will connect to the PROX tcp socket and start sending
  42 commands to run the actual test.
  43 It will print test results on the screen while running.
  44 The PROX instance in the Generator VM will generate packets which will arrive in
  45 the PROX instance running on the SUT (System Under Test) VM. The SUT will then
  46 send the packets back to the generator by swapping source and destination.
  47
  48 Notes about prox_gen_user_data.sh and prox_sut_user_data.sh scripts:
  49 - These scripts contain commands that will be executed using cloud-init at
  50   startup of the VMs. They contain a hard-coded PCI address for the DPDK
  51   interface that will be used by PROX. You might want to check that this is
  52   actually the right PCI address.
  53 - These scripts also assume some specific DPDK directory and tools which might
  54   change over different DPDK release. They have been tested with DPDK-17.02.
  55 - These scripts are also assuming that this interface is on the "dpdk-network"
  56   network managed by OpenStack.
  57