Bob Lantz
Committed by Gerrit Code Review

Added README

Change-Id: I9bb92f93a88e113928a35196ac83954b9e069e5c
1 +Mininet dev tools README
2 +
3 +This directory contains modules for Mininet that are
4 +intended to help with ONOS core and application development.
5 +
6 +They can be imported into Python scripts, or invoked using
7 +mn's --custom option.
8 +
9 +Test topologies for use with Mininet may be found in
10 +../../test/topos
11 +
12 +
13 +onos.py:
14 +
15 +onos.py provides a Mininet controller class which makes it
16 +convenient to create ONOS clusters in a single VM. It also
17 +creates a customizable control network. Additional information
18 +may be found in the module comment and on the docs wiki.
19 +
20 +example: sudo mn --custom onos.py --controller onos,1 --topo linear,10
21 +
22 +
23 +bmv2.py:
24 +
25 +bmv2.py provides a Mininet switch class which enables use of
26 +the BMv2 P4 software switch.
27 +
28 +Additional information may be found on the docs wiki.
29 +
30 +
31 +examples/:
32 +
33 +The examples/ directory contains example scripts which may make
34 +use of onos.py or other modules in this directory.