Splitting the script in 2 parts: createrapid.py and runrapid.py

The split of the scripts is documented in the README file. The VM also
runs now devbind.sh with the proper MAC address to bind the dataplane
interface with the DPDK poll mode driver.

Change-Id: I3e7a6235379dc80530934376c7799ac3396b5325
Luc Provoost <luc.provoost@intel.com>
Signed-off-by: Deepak S <deepak.s@linux.intel.com>

1 files changed, 51 insertions, 13 deletions

diff --git a/VNFs/DPPD-PROX/helper-scripts/openstackrapid/README b/VNFs/DPPD-PROX/helper-scripts/openstackrapid/README
index 49d819d8..7c229904 100644
--- a/VNFs/DPPD-PROX/helper-scripts/openstackrapid/README
+++ b/VNFs/DPPD-PROX/helper-scripts/openstackrapid/README
@@ -31,12 +31,17 @@ image in the same directory with the following characteristics:
 Source the openrc file of the OpenStack environment so that the OpenStack CLI
 commands can be run:
   # source openrc
-Now you can run the rapid.py file. Use help for more info on the usage:
-  # ./rapid.py --help
+Now you can run the createrapid.py file. Use help for more info on the usage:
+  # ./createrapid.py --help
 
-rapid will use the OpenStack CLI to create the flavor, key-pair, network, image,
+runrapid.py will use the OpenStack CLI to create the flavor, key-pair, network, image,
 stack, ...
-Then it will connect to the 2 VMs that have been instantiated and it will launch
+It will create a <STACK>.cfg file containing all info that will be used by runrapid.py
+to actually run the tests. Logging can be found in the CREATE<STACK>.log file
+
+Now you can run the runrapid.py file. Use help for more info on the usage:
+  # ./runrapid.py --help
+The script will connect to the 2 VMs that have been instantiated and it will launch
 PROX in both VMs.
 Once that is done it will connect to the PROX tcp socket and start sending
 commands to run the actual test.
@@ -45,13 +50,46 @@ The PROX instance in the Generator VM will generate packets which will arrive in
 the PROX instance running on the SUT (System Under Test) VM. The SUT will then
 send the packets back to the generator by swapping source and destination.
 
-Notes about prox_gen_user_data.sh and prox_sut_user_data.sh scripts:
-- These scripts contain commands that will be executed using cloud-init at
-  startup of the VMs. They contain a hard-coded PCI address for the DPDK
-  interface that will be used by PROX. You might want to check that this is
-  actually the right PCI address.
-- These scripts also assume some specific DPDK directory and tools which might
-  change over different DPDK release. They have been tested with DPDK-17.02.
-- These scripts are also assuming that this interface is on the "dpdk-network"
-  network managed by OpenStack.
+Notes about prox_user_data.sh script:
+- The script contains commands that will be executed using cloud-init at
+  startup of the VMs.
+- The script also assumes some specific DPDK directory and tools which might
+  change over different DPDK release. This release has been tested with DPDK-17.02.
+
+An example of the cfg file generated by createrapid.py can be found below.
+Note that this file can be created manually in case the stack is created in a
+different way (not using the createrapid.py). This can be useful in case you are
+not using OpenStack as a VIM or when using special configurations that cannot be
+achieved using createrapid.py. Only the [Generator] and [SUT] section are used as
+input for runrapid.py. In the [SUT] section, you can also set admin_ip = 'none'.
+In that case, only the generator will be controlled by runrapid.py and you must
+start the SUT manually.
+
+[Generator]
+admin_ip = 192.168.3.139
+dp_ip = 10.10.10.3
+hex_dp_ip = 0a 0a 0a 03
+dp_mac = fa:16:3e:96:6c:e7
+
+[SUT]
+admin_ip = 192.168.3.133
+dp_ip = 10.10.10.6
+hex_dp_ip = 0a 0a 0a 06
+dp_mac = fa:16:3e:0b:9c:57
+
+[OpenStack]
+stack = rapidTestEnv
+yaml = rapid.yaml
+key = prox
+flavor = prox_flavor
+image = rapidVM
+image_file = rapidVM.qcow2
+dataplane_network = dataplane-network
+subnet = dpdk-subnet
+subnet_cidr = 10.10.10.0/24
+admin_network = admin_internal_net
+
+[rapid]
+loglevel = DEBUG
+version = 17.09.03