minor changes to Makefile and related docs
[sliver-openvswitch.git] / planetlab / exp-tool / Makefile.help
1 in almost all cases below it is recommended to use the -j option to make
2 which was the point with uing make in the first place
3 so that maximum degree of parallelism can be reached
4
5 ==================== usual target
6 make [init+all]
7         shortcut for 'make init all'
8 make init
9         create util subdirs needed by this tool
10 make -j all
11         initialize the whole topology on all nodes
12 ==================== inspect donfig
13 make showslice
14         show SLICE as defined in conf.mk
15 make shownodes
16 make showhostnames
17 make showips
18 make showlinks
19         show nodes and links declared in conf.mk in various formats
20 make sshchecks
21 make ovsversions
22         try out ssh connectivity to slivers in the slice, or show installed ovs version
23 make sshs SSH-COMMAND="bla bla bla"
24         run "bla bla bla" in all slivers (and under sudo)
25 ==================== For changing the topology on the fly
26 make L/<id1>-<id2>
27         create a link between nodes with ids <id1> and <id2>
28 make U/<id1>-<id2>
29         delete link between nodes with ids <id1> and <id2>
30 ==================== cleanup
31 make shutdown
32         tear down everything on the slivers, stops daemons and all
33 make clean
34         clean up whatever has been created on the slivers, keeps daemons running
35 make distclean
36         clean up local cache, useful when restarting from a clean slice
37 ==================== configure (direct switches towards) OF controllers 
38 make showcontrollers
39         show how OF controllers are configured from conf.mk
40         use CONTROLLER_<nodeid> if set, or CONTROLLER as a default otherwise
41         e.g. CONTROLLER=tcp:112.34.23.56:6633
42
43 make controllers
44         configure the various switches so they use the configured controllers
45 ==================== devel
46 make update 
47         push a new version of sliver-ovs into the slivers
48         use SLIVER_OVS that should point to the local new version
49 ==================== manually/progressively deploy stuff (done in make all)
50 make dbs
51         initialize ovs db in all slivers
52 make switchs
53         start ovs switch in all slivers
54 make bridges
55         create a bridge interface linked to tap device in each sliver
56 make start 
57         shortcut for make dbs switchs
58 make stop
59         stop all ovs switch in all slivers
60 make status
61         list status of db and switch processes in all slivers
62 ====================