Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / 4f090a8ee3e9807f11a4b92e0c5e683279bef599
commit4f090a8ee3e9807f11a4b92e0c5e683279bef599[log] [tgz]
authorPavlin Radoslavov <pavlin@onlab.us>Fri Dec 13 18:45:45 2013 -0800
committerPavlin Radoslavov <pavlin@onlab.us>Fri Dec 13 18:45:45 2013 -0800
tree12847def7828c19313a389a6b74025616b636e8e
parent78650b9ba11814d304867db652214302acca735e [diff]
Configure the maven Checkstyle plugin with the Sun Java code style convention.

To generate all site reports (including Checkstyle):
  mvn site
After that, use the following command to generate only the Checkstyle report:
  mvn checkstyle:checkstyle

The report is generated in the following file:

  target/site/checkstyle.html

The Apache Maven Checkstyle plugin URL is:
http://maven.apache.org/plugins/maven-checkstyle-plugin/
1 file changed
tree: 12847def7828c19313a389a6b74025616b636e8e
  1. .gitignore
  2. Authors
  3. Documentation/
  4. LICENSE.txt
  5. NOTICE.txt
  6. PARTNERS.txt
  7. README.md
  8. cluster-mgmt/
  9. conf/
  10. curator/
  11. demo-scripts/
  12. kryo2/
  13. lib/
  14. onos-embedded.sh
  15. perf-scripts/
  16. pom.xml
  17. scripts/
  18. setup-eclipse.sh
  19. setup-local-maven.sh
  20. src/
  21. start-cassandra.sh
  22. start-onos-embedded.sh
  23. start-onos-jacoco.sh
  24. start-onos.sh
  25. start-rest.sh
  26. start-zk.sh
  27. test-network/
  28. testbed-ctrl-add-ext.sh
  29. testbed-ctrl-none.sh
  30. titan/
  31. web/
README.md

ONOS (Open Networking Operating System)

ONOS (Open Networking Operating System) is an experimental distributed SDN OS. Currently, it is under active development. ONOS was announced and demonstrated at ONS'13.

License

Apache 2.0

Steps to download and setup a development Virtual Machine

http://wiki.onlab.us/display/Eng/ONOS+Development+VM

Building ONOS

  1. Install custom jars and dependencies (needs to be run only once)

     $ ./setup-local-maven.sh

  2. Cleanly build ONOS

     $ mvn clean
 $ mvn compile

    NOTE: installing maven for the first time may switch java version from 1.7 to 1.6. This might prevent Cassandra to run.

Dependencies

  1. Zookeeper

    Download and install apache-zookeeper-3.4.5: http://zookeeper.apache.org/releases.html

    Edit file (ONOS-INSTALL-DIR)/start-zk.sh and set variable "ZK_DIR" to point to the Zookeeper directory.

  2. Cassandra

    Download and install apache-cassandra-1.2.4: http://cassandra.apache.org/download/

    Edit file (ONOS-INSTALL-DIR)/start-cassandra.sh and set variable "CASSANDRA_DIR" to point to the Cassandra directory.

Running ONOS with Cassandra as a separate process

[See below for information how to run ONOS with Embedded Cassandra]

  1. Start Zookeeper

     $ cd (ONOS-INSTALL-DIR)/
 $ ./start-zk.sh start

 ## Confirm Zookeeper is running:
 $ ./start.zk.sh status

  2. Start Cassandra

     $ cd (ONOS-INSTALL-DIR)/
 $ ./start-cassandra.sh start

 ## Confirm Cassandra is running:
 $ ./start-cassandra.sh status

  3. Start ONOS

     $ cd (ONOS-INSTALL-DIR)/
 $ ./start-onos.sh start

 ## Confirm ONOS is running:
 $ ./start-onos.sh status

  4. Start ONOS REST API server

     $ cd (ONOS-INSTALL-DIR)/
 $ ./start-rest.sh start

 ## Confirm the REST API server is running:
 $ ./start-rest.sh status

Running ONOS with Cassandra embedded (Optional)

  1. Start Zookeeper

     $ cd (ONOS-INSTALL-DIR)/
 $ ./start-zk.sh start

 ## Confirm Zookeeper is running:
 $ ./start.zk.sh status

  2. Start ONOS and Cassandra embedded

     $ cd (ONOS-INSTALL_DIR)/
 $ ./start-onos-embedded.sh start

 ## Confirm ONOS is running:
 $ ./start-onos-embedded.sh status

  3. Start ONOS REST API server

     $ cd (ONOS-INSTALL-DIR)/
 $ ./start-rest.sh start

 ## Confirm the REST API server is running:
 $ ./start-rest.sh status

Running in offline mode (Optional)

Maven is used to build and run ONOS. By default, maven tries to reach the repositories. The '-o' option can be given to the 'mvn' command to suppress this behavior. The MVN environmental variable can be used to set additional options to the 'mvn' command used in ONOS.

  • Example: Running in offline mode

      $ env MVN="mvn -o" ./start-onos.sh start