Changes between Version 5 and Version 6 of Internal/OpenFlow/Controllers/Nox

Timestamp:

Nov 6, 2010, 4:30:09 AM (14 years ago)

Author:

akoshibe

Comment:

—

Internal/OpenFlow/Controllers/Nox

@@ -1 +1 @@
 = NOX - Network OS =
 NOX is an !OpenFlow controller/ controller development platform. Here we'll use the "destiny" (v0.8) branch of NOX from the Git repository. 
-As of now, a copy of the docs for v0.6 can be found under ./html in my home directory on external2. I shall move this to another, more appropriate place.  
+As of now, a copy of the docs for v0.6 can be found under ./html in my home directory on external2. I shall move this to another, more appropriate place.
 
-== 1. installation ==
+Note: in this documentation, ${NOXPATH} is the arbitrary path to your working nox directory. No such variable actually exists.    
+
+== 1 installation ==
 1. Install git, build-essential, doxygen (for up-to-date NOX docs)
 {{{
@@ -10 +12 @@
 2. Pull NOX from git repo
 {{{ 
+cd ${noxpath}
 git clone git://noxrepo.org/nox
 }}}
@@ -27 +30 @@
 5. generate documentation
 {{{
-cd doc/doxygen            <<--from build directory, not ~/nox
+cd doc/doxygen            <<--from build directory, not ${NOXPATH}/nox
 make html
 }}} 
-== 2. using NOX ==
+
+= 2. using NOX =
 == 2.1. starting up NOX ==
-nox_core is used to start the controller and to load any scripts. It is located under ~/nox/build/src . For example 
+nox_core is used to start the controller and to load any scripts. It is located under ${NOXPATH}/nox/build/src . For example 
 {{{
 ./nox_core -v -i ptcp:6633 switch packetdump
@@ -41 +45 @@
 The information on how to do this can be found in /html/Howto.html under the doxygen generated docs for nox. As the steps require file creation, compilation, ect, you may need root privelages on the machine. The rough steps are as follows:
 
-1. Run nox-new-c-app.py from coreapps, netapps, or webapps (all three directories are found in ${NOXPATH}/nox/src/nox), where ${NOXPATH} is the place with your working nox directory). 
+1. Run nox-new-c-app.py from coreapps, netapps, or webapps (all three directories are found in ${NOXPATH}/nox/src/nox ). 
 {{{
 cd nox/src/nox/coreapps
@@ -80 +84 @@
 }}}
 
+== 3. Customizing your component ==
+All applications under nox are found in either netapps., coreapps, or webapps. Each app is contained in a directory that includes code for the applications' modules (e.g. routing modules implementing specific algorithms), and a list, named meta.json, used by nox to find and load modules at startup. 
+
+By itself, your new component only knows how to initiate a channel with an !OpenFlow switch, and to start up the "liveness check" echo requests. This section is a compilation of information on the nox libraries that can be used to define your own controller. 
+
+== 3.1 Adding flags. ==
+The `configure` function allows you to define options for your application. When starting nox_core, flags can be specified by the application name, followed by an '=', then your flag(s):
+{{{
+./nox_core -v -i ptcp:6633 switch="noflow"
+}}}
+I'm guessing if it can take multiple options, you can string multiple flags by delimiting each option with a comma or another '='.
+
+ 
+
+ 
+