Skip to content

Commit

Permalink
Updates documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Raphael Vicente Rosa <[email protected]>
  • Loading branch information
raphaelvrosa committed Jul 30, 2019
1 parent d053e79 commit 1eefc3a
Showing 1 changed file with 6 additions and 21 deletions.
27 changes: 6 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down

0 comments on commit 1eefc3a

Please sign in to comment.