Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / 4ae02820a1939697a3da2c13e91a0406fd6a38b7
commit4ae02820a1939697a3da2c13e91a0406fd6a38b7[log] [tgz]
authorRay Milkey <ray@onlab.us>Mon Mar 24 17:00:40 2014 -0700
committerGerrit Code Review <gerrit2@onos-services>Wed Mar 26 11:19:37 2014 -0700
tree70200af1c752aa2a7ce00d1ed7832c554b045949
parent6a6431303dbfa6a7a925dcd4ca3a1ad7b7e8023d [diff]
Checkstyle and PMD violations fixed for IControllerRegistryService class.

Missed a couple of Checkstyle problems.

Change-Id: Icd001458ddb659547bc1f4c6027c308504865540

Reapply checkstyle/PMD changes based on new rulesets.

Put 'public' declarations back on methods
Fixed javadoc comment formatting that got mangkled
by idea.

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

  2. RAMCloud

    Run setup-ramcloud.sh to install RAMCloud git repository

Configuration

To configure the processes (ONOS, RAMCLoud and Zookeper) refers to the files in (ONOS-INSTALL-DIR)/conf. A detailed explanation is given in the ONOS WiKi: - "ONOS Documentation/Getting Started with ONOS/Running the RAMCloud branch of ONOS"

Running ONOS with RAMCloud as a separate process

  1. Start Zookeeper

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

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

  2. Start RAMCloud Coordinator (only one for cluster)

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

 ## Confirm RAMCloud Coordinator is running:
 $ ./start-ramcloud-coordinator.sh status

  3. Start RAMCloud Server

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

 ## Confirm RAMCloud Server is running:
 $ ./start-ramcloud-server.sh status

  4. Start ONOS

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

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

  5. Start ONOS REST API server

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

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

Developing 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