Small readme to get started

Signed-off-by: Benjamin Hesmans <benjamin.hesmans@uclouvain.be>
This commit is contained in:
Benjamin Hesmans 2015-03-05 16:32:33 +01:00
parent c478c315cd
commit 8800f76e55
2 changed files with 59 additions and 0 deletions

50
README.rst Normal file
View File

@ -0,0 +1,50 @@
What ?
------
Simple tool, based on `mininet <http://mininet.org/>`_, to boot a simple network
with n paths and run experiments between two hosts.
Usage
-----
.. code-block:: console
./mpPerf -t topo -x xp
The format for the topo file and xp file is simple but could be different based
on the type of topo or experiments. Details should follow.
basic Example
-------------
.. code-block:: console
./mpPerf -t conf/topo/simple_para
The content of simple_para is:
.. code-block:: console
desc:Simple configuration with two para link
topoType:MultiIf
leftSubnet:10.0.
rightSubnet:10.1.
#path_x:delay,queueSize(may be calc),bw
path_0:10,10,5
path_1:40,40,5
path_2:30,30,2
path_3:20,20,1
``topoType`` just specifies that we want to have multiple interfaces, one for
each path.
Each path is defined by 3 values, delay (one way, int, in ms), queue_size (int,
in packets), and bandwidth (float, in mbit/s).
Once the configuration is up, you have access to the CLI. You can check route
configuration (policy routing etc.) Just by issuing regular commands preceded
by ``Client`` or ``Server``
They are other option and experiments, but the documentation is still to be
written.

View File

@ -0,0 +1,9 @@
desc:Simple configuration with two para link
topoType:MultiIf
leftSubnet:10.0.
rightSubnet:10.1.
#path_x:delay,queueSize(may be calc),bw
path_0:10,10,5
path_1:40,40,5
path_2:30,30,2
path_3:20,20,1