Setting tag sliver-openvswitch-2.2.90-1
[sliver-openvswitch.git] / planetlab / exp-tool / Makefile.help
index e9be270..d0f53cf 100644 (file)
@@ -1,9 +1,30 @@
+in almost all cases below it is recommended to use the -j option to make
+which was the point with uing make in the first place
+so that maximum degree of parallelism can be reached
+
+**********************************************************
+Note: to get the greatest speedup from make -j you should also enable
+connection reuse in your ssh setup, e.g., by having the following lines
+in your .ssh/config:
+host *
+       ControlMaster auto
+       ControlPath ~/.ssh/ssh_mux_%h_%p_%r
+       ControlPersist 4h
+
+Please note, however, that maximum concurrent per-node reuse is usually
+set to something low (typically 10), and this is a problem if some node
+in your topology has many links. In this case you should raise that limit
+on the slivers, or limit makefile concurrency (e.g., by using make -j10).
+**********************************************************
+
+==================== usual target
 make [init+all]
         shortcut for 'make init all'
 make init
         create util subdirs needed by this tool
-make all
+make -j all
         initialize the whole topology on all nodes
+==================== inspect donfig
 make showslice
         show SLICE as defined in conf.mk
 make shownodes
@@ -14,26 +35,50 @@ make showlinks
 make sshchecks
 make ovsversions
         try out ssh connectivity to slivers in the slice, or show installed ovs version
+make sshs SSH-COMMAND="bla bla bla"
+       run "bla bla bla" in all slivers (and under sudo)
+==================== For changing the topology on the fly
+make L/<id1>-<id2>
+       create a link between nodes with ids <id1> and <id2>
+make U/<id1>-<id2>
+       delete link between nodes with ids <id1> and <id2>
+==================== cleanup
+make shutdown
+       tear down everything on the slivers, stops daemons and all
+make clean
+       clean up whatever has been created on the slivers, keeps daemons running
+make distclean
+       clean up local cache, useful when restarting from a clean slice
+==================== configure (direct switches towards) OF controllers 
+make showcontrollers
+       show how OF controllers are configured from conf.mk
+       use CONTROLLER_<nodeid> if set, or CONTROLLER as a default otherwise
+       e.g. CONTROLLER=tcp:112.34.23.56:6633
+
+make controllers
+       configure the various switches so they use the configured controllers
+make del-controllers
+       reset the switches to run in standalone mode
+==================== devel
+make update 
+       push a new version of sliver-ovs into the slivers
+       use SLIVER_OVS that should point to the local new version
+==================== manually/progressively deploy stuff (done in make all)
 make dbs
         initialize ovs db in all slivers
 make switchs
         start ovs switch in all slivers
+make bridges
+        create a bridge interface linked to tap device in each sliver
 make start 
         shortcut for make dbs switchs
 make stop
         stop all ovs switch in all slivers
 make status
         list status of db and switch processes in all slivers
-make bridges
-        create a bridge interface linked to tap devce in each sliver
 ====================
-make showcontrollers
-       show how OF controllers are configured from conf.mk
-       use CONTROLLER_<nodeid> if set, or CONTROLLER as a default otherwise
-make controllers
-       configure the various switches so they use the configured controllers
-
+make gprobes
+       Uses GMAP_SERVER and GMAP_PROBES to run probes in selected slivers
+       that can update a googlemap server for animating link speeds
+       This of course is mostly a demo thing, based on a one-host ndnmap deployment for now
 ====================
-make update (devel)
-       push a new version of sliver-ovs into the slivers
-       use SLIVER_OVS that should point to the local new version