From 1eefc3a03e83370e9eca1773e1cddb724287dd36 Mon Sep 17 00:00:00 2001 From: Raphael Vicente Rosa Date: Tue, 30 Jul 2019 20:54:12 -0300 Subject: [PATCH] Updates documentation Signed-off-by: Raphael Vicente Rosa --- README.md | 27 ++++++--------------------- 1 file changed, 6 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 81f9329..3925b1a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Gym -**Notice**: this is a beta release, and during the month of May/2019 this repository is going to be updated with more code, reviews and documentation, stay tuned! - This is a project to bring into reality the ideas designed in VBaaS (VNF Benchmarking-as-a-Service). The main purpose of this source code is a modular ad-hoc platform for testing VNFs and their respective infrastructure. @@ -103,12 +101,10 @@ Uses the containernet platform to deploy agents and a dummy VNF, which just bypa Uses the containernet platform to deploy agents and a dummy VNF, which just bypass the traffic among its ports. The agents perform the execution of ping/iperf3 traffic through the target VNF, while its container is monitored during the test. -Before running Test 2, you need to create the (SUT) VNF bypass docker image, following: +If not yet created, before running Test 2, you need to create the (SUT) VNF bypass docker image, following: ```bash -$ git clone https://github.com/raphaelvrosa/gym-vnfs -$ cd gym-vnfs -$ sudo chmod +x build.sh -$ sudo ./build.sh +$ cd gym/tests/utils +$ sudo ./build_reqs.sh ``` ### Test 3 @@ -117,21 +113,10 @@ Uses the containernet platform to deploy agents and a Suricata-IDS VNF. The agen The test consists in executing different pcap files using tcpreplay while the VNF suricata has loaded different rule sets. In the end all the metrics are saved into csv files into the gym/tests/csv folder, included the timeseries monitoring of the container, and the overall VNF-PP metrics according to the VNF-BD input parameters. -Before running Test 3, you need to create the (SUT) Suricata IDS docker image, following: -```bash -$ git clone https://github.com/raphaelvrosa/gym-vnfs -$ cd gym-vnfs -$ sudo chmod +x build.sh -$ sudo ./build.sh -``` - -In addition, as Test 3 uses pcap files to be sent via tcpreplay by an Agent, you also need to download such pcaps: +If not yet created, before running Test 3, you need to create the (SUT) Suricata IDS docker image and download pcap files, following: ```bash -$ wget https://s3.amazonaws.com/tcpreplay-pcap-files/smallFlows.pcap -$ wget https://s3.amazonaws.com/tcpreplay-pcap-files/bigFlows.pcap -$ sudo mkdir /mnt/pcaps/ -$ sudo mv bigFlows.pcap /mnt/pcaps/ -$ sudo mv smallFlows.pcap /mnt/pcaps/ +$ cd gym/tests/utils +$ sudo ./build_reqs.sh ``` After that the Agent source of stimulus will be able to mount the /mnt/pcaps/ directory and replay the pcap files for Test 3.