Gitiles
Code Review Sign In
gerrit.onosproject.org / spring-open / d150ece4ff7a3e0e2af201faf66092e385f0a76d
commitd150ece4ff7a3e0e2af201faf66092e385f0a76d[log] [tgz]
authorYuta HIGUCHI <y-higuchi@onlab.us>Tue Apr 29 16:25:36 2014 -0700
committerYuta HIGUCHI <y-higuchi@onlab.us>Mon May 05 13:05:37 2014 -0700
treefcde587220661281ab5d14f6beeb7067d9748870
parente123942753d0af4f68de91a849964bf890fd6158 [diff]
Update RAMCloud start-up procedure

This patch will enable RAMCloud coordinator failover and
server failover if number of replica is properly configured.

- Update onos.sh RAMCloud start-up procedure
  - Use ZooKeeper to manage cluster member
  - Specify cluster name, num replicas,...
  - WARN: ramcloud.coordinator.ip is now a configuration to specify listen address
  - Specify ZooKeeper address/ClusterName in RAMCloud client config (conf/ramcloud.conf)
    - Note: conf/ramcloud.conf ramcloud.coordinatorIp, etc. is no longer used for connection
  - Enable failure detector, which is required for fail-over feature
- Undocumented maintenance option "deldb" to remove:
  - RAMCloud coordination info in ZK
    - Note: ZooKeeper must be running in order to execute "./onos.sh rc-c deldb"
  - BackupData file created by RAMCloud Storage Server
- Update RAMCloud Java bindings
  - Expose API to specify RAMCloud ClusterName
  - Expose ClientExeption
  - Note: You need to run ./build-ramcloud-java-bindings.sh to update Java bindings
- Utility function to check if ZooKeeper is running
- Utility function to wait for ZooKeeper to start
- Modified kill-processes() to try killing process gracefully first then KILL
- Specify absolute path to pgrep/pkill
- Added "rc" to manipulate both server and coordinator

Change-Id: Ia8a282f81bf82810a4d000883611ce12f504bd16
5 files changed
tree: fcde587220661281ab5d14f6beeb7067d9748870
  1. .gitignore
  2. .gitreview
  3. Authors
  4. LICENSE.txt
  5. NOTICE.txt
  6. PARTNERS.txt
  7. README.md
  8. build-ramcloud-java-bindings.sh
  9. cluster-mgmt/
  10. conf/
  11. install-oracle-java.sh
  12. lib/
  13. old-scripts/
  14. onos.sh
  15. pom.xml
  16. prep-for-offline.sh
  17. ramcloud-build-scripts/
  18. sample/
  19. scripts/
  20. setup-eclipse.sh
  21. setup-ramcloud.sh
  22. src/
  23. start-ons2014demo.sh
  24. start-rest.sh
  25. vm-utils/
  26. 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, '14.

License

Apache 2.0

Steps to download and setup a development Virtual Machine

https://wiki.onlab.us:8443/display/onosdocs/Getting+Started+with+ONOS

Building ONOS

  1. Cleanly build ONOS

     $ cd ${ONOS_HOME}/
 $ mvn clean
 $ mvn compile

External Dependencies

  1. Required packages

     $ sudo apt-get install maven python-flask

  2. ZooKeeper

    Download and install apache-zookeeper-3.4.5: http://zookeeper.apache.org/releases.html

    By default ONOS expect ZooKeeper to be installed in ~/zookeeper-3.4.5.
    This can be changed by specifing the path using ZK_HOME environment variable.

    Data directory ZooKeeper uses by default is /var/lib/zookeeper. You will need to give current user permission to write to this directory.

    This directory can be changed using specifying ZK_LIB_DIR environment variable and running ./onos.sh setup to generate ${ONOS_HOME}/conf/zoo.cfg.

    See Configuration for details about ./onos.sh setup.

  3. RAMCloud

    Run setup-ramcloud.sh to download and install RAMCloud to ~/ramcloud.
    Installation path can be changed by specifing RAMCLOUD_HOME environment variable.

     $ cd ${ONOS_HOME}/
 $ ./setup-ramcloud.sh

Configuration

./onos.sh setup script is used to generate ONOS related configuration files. This script read configuration from "${ONOS_CONF_DIR}/onos_node.`hostname`.conf".

Copy the file "${ONOS_HOME}/conf/onos_node.conf" to match the hostname and configure the content appropriately.
e.g., To use RAMCloud as data store change host.backend to ramcloud

Once you're done with required configuration run following to generate configuration files.

    $ cd ${ONOS_HOME}/
    $ ./onos.sh setup

Running ONOS and required components

To start ZooKeeper, RAMCloud (if enabled in configuration) and ONOS core.

    $ cd ${ONOS_HOME}/
    $ ./onos.sh start single-node

To stop all the above

    $ cd ${ONOS_HOME}/
    $ ./onos.sh stop

If you need to use the REST APIs, follow the instruction for "Start ONOS REST API server" in next section.

Running ONOS and required components one by one

You can manually start/stop individual ONOS components as follows:

  1. Start Zookeeper

     $ cd ${ONOS_HOME}/
 $ ./onos.sh zk start

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

  2. Start RAMCloud Coordinator (only on one of the node in cluster)

     $ cd ${ONOS_HOME}/
 $ ./onos.sh rc-coord start

 ## Confirm RAMCloud Coordinator is running:
 $ ./onos.sh rc-coord status

  3. Start RAMCloud Server

     $ cd ${ONOS_HOME}/
 $ ./onos.sh rc-server start

 ## Confirm RAMCloud Server is running:
 $ ./onos.sh rc-server status

  4. Start ONOS

     $ cd ${ONOS_HOME}/
 $ ./onos.sh core start

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

  5. Start ONOS REST API server

     $ cd ${ONOS_HOME}/
 $ ./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