Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / 70d91cc2bbf25172761dadaf0da8d64188bfe993
commit70d91cc2bbf25172761dadaf0da8d64188bfe993[log] [tgz]
authorRay Milkey <ray@onlab.us>Tue Mar 18 15:22:27 2014 -0700
committerGerrit Code Review <gerrit2@onos-services>Thu Mar 20 16:52:05 2014 -0700
treef9f6d5ea12b8129ba4c58f232c7ae1a3e42fdcb4
parent9e356cac01ee8bbd77014e0cc1395de6d511e11e [diff]
Added rules and exclusions for checkstyle, findbugs and pmd

The checkstyle, findbugs and pmd reports will now run only on net.onrc... classes.

Added rulesets and suppressions to implement a first pass of reasonable rules to follow for ONOS sources.

Address Yuta's review comments

Make <id> tags in executions consistent
Fix header comment in ruleset and suppression
Add '_' as a valid character in rule names

Change-Id: I1045f751fd27b0d0e815329cc34f0a780c9b38af

Address Pavlin's comments on checkstyle rules.

Change-Id: I1045f751fd27b0d0e815329cc34f0a780c9b38af
5 files changed
tree: f9f6d5ea12b8129ba4c58f232c7ae1a3e42fdcb4
  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. onos-embedded.sh
  15. perf-scripts/
  16. pom.xml
  17. prep-for-offline.sh
  18. ramcloud-build-scripts/
  19. scripts/
  20. setup-eclipse.sh
  21. setup-ramcloud.sh
  22. src/
  23. start-cassandra.sh
  24. start-onos-embedded.sh
  25. start-onos-jacoco.sh
  26. start-onos.sh
  27. start-ramcloud-coordinator.sh
  28. start-ramcloud-server.sh
  29. start-rest.sh
  30. start-zk.sh
  31. test-network/
  32. testbed-ctrl-add-ext.sh
  33. testbed-ctrl-none.sh
  34. titan/
  35. vm-utils/
  36. 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