| Naoki Shiota | e673366 | 2014-04-25 18:29:07 -0700 | [diff] [blame] | 1 | ONOS Configuration files |
| 2 | ======================== |
| 3 | |
| 4 | This directory contains configuration files related to ONOS execution and |
| 5 | ONOS development environment. This file explains composition of configuration |
| 6 | files and purpose of each file. |
| 7 | |
| 8 | |
| 9 | Execution configuration |
| 10 | ======================= |
| 11 | |
| 12 | ONOS needs several configuration files, but most of them can be generated |
| 13 | automatically. All you have to do is to adjust ONOS node configuration file |
| 14 | to your environment and run "${ONOS_HOME}/onos.sh setup" to generate other |
| 15 | configuration files. If you want to configure each modules in detail, you |
| 16 | can modify the generated files manually. Note that generated files may be |
| 17 | overwritten if you run "${ONOS_HOME}/onos.sh setup" again. |
| 18 | |
| 19 | Description of files |
| 20 | -------------------- |
| 21 | - onos_node.conf |
| 22 | ONOS node configuration file. zoo.cfg, ramcloud.conf, hazelcast.xml and |
| 23 | logback.`hostname`.xml will be derived from information in this file. |
| 24 | If you modify this file, run "${ONOS_HOME}/onos.sh setup" to reflect the |
| 25 | change to configuration files. Other than generation of configuration |
| 26 | files, this file is also used when ONOS starts up. |
| 27 | If file named "onos_node.`hostname`.conf" exists in this directory, that |
| 28 | file will be used instead of onos_node.conf. |
| 29 | |
| 30 | - onos.properties |
| 31 | Java properties read by ONOS process. |
| 32 | |
| 33 | - zoo.cfg |
| 34 | ZooKeeper configuration file (generated file). |
| 35 | |
| 36 | - ramcloud.conf |
| 37 | RAMCloud configuration file (generated file). |
| 38 | |
| 39 | - hazelcast.xml |
| 40 | Hazelcast configuration file (generated file). |
| 41 | |
| 42 | - logback.`hostname`.xml |
| 43 | Logback configuration file (generated file). |
| 44 | |
| 45 | - template/* |
| 46 | Templates of configuration files referred during generation of file. |
| 47 | DO NOT change or delete these files. |
| 48 | |
| 49 | - *.bak |
| 50 | Backup files created during generation of configuration files. If you |
| 51 | overwrite files by mistake, you can recover them by these backup files. |
| 52 | |
| 53 | |
| 54 | Development environment configuration |
| 55 | ===================================== |
| 56 | |
| 57 | In development process, ONOS uses several tools to make development efficient |
| 58 | or to assure the quality of the code. These files are configuration of those |
| 59 | development tools. DO NOT change or remove these files without any particular |
| 60 | reason. |
| 61 | |
| 62 | Description of files |
| 63 | -------------------- |
| 64 | - checkstyle/* |
| 65 | Configuration files of Checkstyle, which inspects the codes to find |
| 66 | violations to the ONOS coding standard. |
| 67 | |
| 68 | - findbugs/* |
| 69 | Configuration files of FindBugs, which analyzes the codes to find potential |
| 70 | bugs. |
| 71 | |
| 72 | - pmd/* |
| 73 | Configuration files of PMD, which detects potential programming mistakes |
| 74 | or flaws that tends to lead error. |