blob: e1e52adbcdbbc51bc573ff0b3508f406ccec9fc7 [file] [log] [blame] [view]
Ashlesh Gawandef5f304b2016-06-16 16:42:41 -05001Mini-NDN cluster edition
2========================
3
4Mini-NDN cluster edition uses the experimental Mininet cluster edition.
5**Make sure that you can run the Mininet cluster edition by following
6[these instructions](https://github.com/mininet/mininet/wiki/Cluster-Edition-Prototype)**.
7Mini-NDN will use the "mininet" username created in Mininet cluster edition setup.
8
9## Mini-NDN cluster options
10
11To run Mini-NDN cluster on `localhost` and another server `server1` with
12the guided node placement strategy (default), the following command can be used:
13
14 sudo minindn --cluster=localhost,server1 --place-list=1,3
15
16Note that `place-list` specifies the number of nodes to be placed on the corresponding servers
17of the cluster.
18In the example, one node will be placed on `localhost` and three nodes on `server1`.
19Unless specified, the default 4 node topology is used.
20Another placement can be `roundRobin` placement algorithm from Mininet.
21This does not require a place-list.
22
23 sudo minindn --cluster=localhost,server1 --placement roundRobin
24
25By default the tunnel type used is SSH, but GRE tunnel can be specified by `--tunnel-type=gre`