| Naoki Shiota | 611f3dd | 2014-05-30 11:38:37 -0700 | [diff] [blame] | 1 | ONOS cluster management tools |
| 2 | ============================= |
| 3 | |
| 4 | This directory contains tools related to configuration and management of |
| 5 | ONOS cluster. This file explains role of each script and composition of |
| 6 | configuration files. |
| 7 | |
| 8 | |
| 9 | Cluster management overview |
| 10 | =========================== |
| 11 | |
| 12 | ONOS cluster needs lots of configuration files and that makes it hard to keep |
| 13 | consistency of configuration among ONOS nodes. Also, starting up and shutting |
| 14 | down ONOS nodes needs CLI execution on each nodes. Cluster management tools |
| 15 | are designed to kill those painful steps by centralizing interface into one |
| 16 | host. |
| 17 | |
| 18 | Cluster management tools can create configuration files for each node and |
| 19 | apply them. Cluster management tools can also start up and shut down all ONOS |
| 20 | nodes simultaneously. If you want to see status of ONOS cluster, those tools |
| 21 | can show status of all nodes at once. |
| 22 | |
| 23 | Cluster management tools also contain Mininet deployment tool. This tool can |
| 24 | create Mininet network with arbitrary topology and with arbitrary controller |
| 25 | assignment. If you want to run ONOS on virtual network, this tool can help. |
| 26 | |
| 27 | |
| 28 | Composition of files |
| 29 | ==================== |
| 30 | |
| 31 | Cluster management tools consist of some script files and configuration files. |
| 32 | |
| 33 | Description of files |
| 34 | -------------------- |
| 35 | - onos-cluster.sh |
| 36 | Main script to manage ONOS cluster. This script can create and deploy |
| 37 | configuration files for each hosts, and can start/stop ONOS cluster. |
| 38 | This script can also show status of ONOS cluster nodes. |
| 39 | Try "onos-cluster.sh" to see detailed usage. |
| 40 | |
| 41 | - conf/onos-cluster.conf |
| 42 | Configuration file of ONOS cluster. This is the only file you need to |
| 43 | modify. See into the file for parameter detail. |
| 44 | |
| 45 | - conf/generated/* |
| 46 | Configuration files generated by onos-cluster.sh. |
| 47 | |
| 48 | - conf/logs |
| 49 | Console logs of each nodes generated during deployment of configuration. |
| 50 | |
| 51 | - conf/template/* |
| 52 | Templates of configuration files referred during generation of file. |
| 53 | DO NOT change or delete these files. |
| 54 | |
| 55 | - mininet/start_topo.py |
| 56 | Script to start Mininet. This script read topology file and create |
| 57 | topology as described. This script also connect virtual switches to ONOS |
| 58 | cluster nodes according to topology file. |
| 59 | |
| 60 | - mininet/topo.py |
| 61 | Topology file used by start_topo.py. |