Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / b41100aaba399bff210b8db55b40aa1fb3156184
commitb41100aaba399bff210b8db55b40aa1fb3156184[log] [tgz]
authorRay Milkey <ray@onlab.us>Thu Apr 10 10:42:15 2014 -0700
committerGerrit Code Review <gerrit2@onos-services>Thu Apr 10 11:03:18 2014 -0700
treedc788a891baa39eb2e64af0f2725a9e41acb74ff
parent55e281faef4a40e6f38de8d2b336b0d73c9961fb [diff]
Enable checkstyle Javadoc Comment Style rule

Turn on the Javadoc Comment Style rule and fix
any violations that come up.  This is related to
requiring javadoc description comments to end
with a '.'

Change-Id: I19cf1b9f00d3040987e0b4c8b39461e2e0ad66b5
46 files changed
tree: dc788a891baa39eb2e64af0f2725a9e41acb74ff
  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. install-oracle-java.sh
  13. lib/
  14. old-scripts/
  15. onos.sh
  16. pom.xml
  17. prep-for-offline.sh
  18. ramcloud-build-scripts/
  19. sample/
  20. scripts/
  21. setup-eclipse.sh
  22. setup-ramcloud.sh
  23. src/
  24. start-onos-jacoco.sh
  25. start-onos.sh
  26. start-ons2014demo.sh
  27. start-ramcloud-coordinator.sh
  28. start-ramcloud-server.sh
  29. start-rest.sh
  30. start-zk.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