Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / 2caf029ed302e2f04bd967fe7440ae8f44cc0d7e
commit2caf029ed302e2f04bd967fe7440ae8f44cc0d7e[log] [tgz]
authorJonathan Hart <jono@onlab.us>Tue Feb 25 15:40:55 2014 -0800
committerJonathan Hart <jono@onlab.us>Tue Feb 25 15:58:00 2014 -0800
treecc9c822b5665d27337f4c106f013c76cb90e51a8
parent31ebc47206a9a0372c3722d1b3a1df50c07d8b69 [diff]
Added note about the URL

Change-Id: Iad4ea1adbf051b67090561ecf707d28bb1867326
1 file changed
tree: cc9c822b5665d27337f4c106f013c76cb90e51a8
  1. .gitignore
  2. .gitreview
  3. Authors
  4. Documentation/
  5. LICENSE.txt
  6. NOTICE.txt
  7. PARTNERS.txt
  8. README.md
  9. blueprints-README.md
  10. build-ramcloud-java-bindings.sh
  11. cluster-mgmt/
  12. conf/
  13. curator/
  14. demo-scripts/
  15. lib/
  16. logcabin.patch
  17. onos-embedded.sh
  18. perf-scripts/
  19. pom.xml
  20. prep-for-offline.sh
  21. rebuild-local-repo.sh
  22. repo/
  23. scripts/
  24. setup-eclipse.sh
  25. setup-ramcloud.sh
  26. src/
  27. start-cassandra.sh
  28. start-onos-embedded.sh
  29. start-onos-jacoco.sh
  30. start-onos.sh
  31. start-ramcloud-coordinator.sh
  32. start-ramcloud-server.sh
  33. start-rest.sh
  34. start-zk.sh
  35. test-network/
  36. testbed-ctrl-add-ext.sh
  37. testbed-ctrl-none.sh
  38. titan/
  39. vm-utils/
  40. 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. 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.

External 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

Developping ONOS in offline environment (Optional)

Maven need the Internet connection to download required dependencies and plugins, when they're used for the first time.

If you need to develop ONOS in an Internet unreachable environment you may want to run the following helper script before you go offline, so that required dependencies and plugins for frequently used maven target will be downloaded to your local environment.

    $ ./prep-for-offline.sh

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