Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / 9df15d3d82ff987b6b1080e6f2da57569df1729d
commit9df15d3d82ff987b6b1080e6f2da57569df1729d[log] [tgz]
authorNaoki Shiota <n-shiota@onlab.us>Thu Mar 27 14:26:20 2014 -0700
committerGerrit Code Review <gerrit2@onos-services>Mon Mar 31 13:12:29 2014 -0700
tree659f0d9409acbeda4f373893e50b79257997bfdd
parentd8533b5ab9aeeb1b462f41961e798d6d28062fe4 [diff]
Refactored startup script.

  - Added onos_node.cfg as centralized config file
    - To configure choice of backend (hazelcast/ramcloud)
    - To configure ZooKeeper cluster member
    - To create myid
    - To configure default startup mode (single-node/coord-node/server-node)
    - To configure RAMCloud address/port
  - Added "onos.sh setup" option to create logback.xml and zoo.cfg
  - A few bugfixes

Change-Id: I76fd23967087ad73ae42742288b8c548c2c2202f
3 files changed
tree: 659f0d9409acbeda4f373893e50b79257997bfdd
  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. install-oracle-java.sh
  14. lib/
  15. onos.sh
  16. perf-scripts/
  17. pom.xml
  18. prep-for-offline.sh
  19. ramcloud-build-scripts/
  20. scripts/
  21. setup-eclipse.sh
  22. setup-ramcloud.sh
  23. src/
  24. start-onos-jacoco.sh
  25. start-onos.sh
  26. start-ramcloud-coordinator.sh
  27. start-ramcloud-server.sh
  28. start-rest.sh
  29. start-zk.sh
  30. test-network/
  31. testbed-ctrl-add-ext.sh
  32. testbed-ctrl-none.sh
  33. vm-utils/
  34. 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