resources/bin/README

   1 # README
   2 #
   3 # ovsdb-build
   4 # Author: Dave Tucker <dave.j.tucker@hp.com>
   5 #
   6 #
   7
   8 The script in this commit simplifies the build process of the OVSDB
   9 project.
  10 usage: ovsdb-build [-h] [-r] [-b] [-of13] [-v] [-g CHANGE_ID] [-start]
  11 [-stop]
  12                    [-d DIRECTORY] [-t]
  13 optional arguments:
  14   -h, --help            show this help message and exit
  15   -r, --reclone         Reclone the Controller/OVSDB repos
  16   -b, --rebuild         Build the Controller Project
  17   -of13, --openflow13   Enable OpenFlow 1.3 Support
  18   -v, --verbose         Verbose output
  19   -g CHANGE_ID, --gerrit CHANGE_ID
  20                         Gerrit Change ID
  21   -start, --start       Start the controller
  22   -stop, --stop         Stop the controller
  23   -d DIRECTORY, --directory DIRECTORY
  24                         directory
  25   -t, --tmux            Create tmux session
  26
  27 On first run it is recommended to run the following:
  28
  29 ./ovsdb-build -r -b -start
  30
  31 You can add the `-d` option to specify the directory you want to build
  32 in:
  33
  34 ./ovsdb-build -r -b -d /home/dave/dev/opendaylight -start
  35
  36 This will clone the controller and ovsdb projects, build them, move the
  37 ovsdb artifacts in to the controller directory and start the controller.
  38
  39 Gerrit Changes can be built and loaded to the controller with a single
  40 command:
  41
  42 ./ovsbd-build -g 5716 -start
  43
  44 The controller is started in the background. To access the OSGi ole
  45 you can manually `telnet 127.0.0.1 2400` or you can add `-t` to let
  46 the build script create a tmux session for you.
  47
  48
  49