Merge branch 'mainstream'
[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 **********************************************************
6 Note: to get the greatest speedup from make -j you should also enable
7 connection reuse in your ssh setup, e.g., by having the following lines
8 in your .ssh/config:
9 host *
10         ControlMaster auto
11         ControlPath ~/.ssh/ssh_mux_%h_%p_%r
12         ControlPersist 4h
13
14 Please note, however, that maximum concurrent per-node reuse is usually
15 set to something low (typically 10), and this is a problem if some node
16 in your topology has many links. In this case you should raise that limit
17 on the slivers, or limit makefile concurrency (e.g., by using make -j10).
18 **********************************************************
19
20 ==================== usual target
21 make [init+all]
22         shortcut for 'make init all'
23 make init
24         create util subdirs needed by this tool
25 make -j all
26         initialize the whole topology on all nodes
27 ==================== inspect donfig
28 make showslice
29         show SLICE as defined in conf.mk
30 make shownodes
31 make showhostnames
32 make showips
33 make showlinks
34         show nodes and links declared in conf.mk in various formats
35 make sshchecks
36 make ovsversions
37         try out ssh connectivity to slivers in the slice, or show installed ovs version
38 make sshs SSH-COMMAND="bla bla bla"
39         run "bla bla bla" in all slivers (and under sudo)
40 ==================== For changing the topology on the fly
41 make L/<id1>-<id2>
42         create a link between nodes with ids <id1> and <id2>
43 make U/<id1>-<id2>
44         delete link between nodes with ids <id1> and <id2>
45 ==================== cleanup
46 make shutdown
47         tear down everything on the slivers, stops daemons and all
48 make clean
49         clean up whatever has been created on the slivers, keeps daemons running
50 make distclean
51         clean up local cache, useful when restarting from a clean slice
52 ==================== configure (direct switches towards) OF controllers 
53 make showcontrollers
54         show how OF controllers are configured from conf.mk
55         use CONTROLLER_<nodeid> if set, or CONTROLLER as a default otherwise
56         e.g. CONTROLLER=tcp:112.34.23.56:6633
57
58 make controllers
59         configure the various switches so they use the configured controllers
60 make del-controllers
61         reset the switches to run in standalone mode
62 ==================== devel
63 make update 
64         push a new version of sliver-ovs into the slivers
65         use SLIVER_OVS that should point to the local new version
66 ==================== manually/progressively deploy stuff (done in make all)
67 make dbs
68         initialize ovs db in all slivers
69 make switchs
70         start ovs switch in all slivers
71 make bridges
72         create a bridge interface linked to tap device in each sliver
73 make start 
74         shortcut for make dbs switchs
75 make stop
76         stop all ovs switch in all slivers
77 make status
78         list status of db and switch processes in all slivers
79 ====================
80 make gprobes
81         Uses GMAP_SERVER and GMAP_PROBES to run probes in selected slivers
82         that can update a googlemap server for animating link speeds
83         This of course is mostly a demo thing, based on a one-host ndnmap deployment for now
84 ====================