Changes between Initial Version and Version 1 of Layer1Transport/Install


Ignore:
Timestamp:
07/16/13 14:02:22 (11 years ago)
Author:
tupty@bbn.com
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • Layer1Transport/Install

    v1 v1  
     1[[PageOutline]]
     2
     3= Introduction =
     4This page describes how to install the layer1transport service.
     5
     6= Variables =
     7|| '''Name'''                || '''Description'''             || '''Default Values''' || '''Files that use these values''' ||
     8|| <version>                 || Version of layer1transport    ||                      ||                                   ||
     9|| <floodlight_jar>          || Path to floodlight jar file   ||                      ||                                   ||
     10|| <rest_port>               || REST API port for FL          || 18080                || init.d script, properties file    ||
     11|| <of_port>                 || OF controller port for FL     || 11750                || properties file                   ||
     12
     13= Installation Instructions =
     14These are instructions to install the layer1transport service.  These instructions were created and tested using an Ubuntu 10.04 system.
     15
     16== 1. Create openflow user ==
     17Create a user named openflow on the system to run this service. 
     18
     19== 2. Obtain the software ==
     20The software for the layer1transport service can be downloaded at http://www.gpolab.bbn.com/local-sw/.  Download the tarball, and place it in the openflow user's home directory.
     21
     22== 3. Unpack the tarball ==
     23Unpack the tarball and rename the top level directory
     24{{{
     25sudo -u openflow tar xvzf /home/openflow/layer1transport-<version>.tar.gz
     26sudo -u openflow mv /home/openflow/layer1transport/ /home/openflow/floodlight/
     27}}}
     28
     29== 4. Install curl ==
     30Make sure that the system has curl installed on it.
     31
     32== 5. Install Floodlight ==
     33The layer1transport service currently using a pre-built jar file of Floodlight 0.9.  Floodlight installation instructions can be found at http://docs.projectfloodlight.org/display/floodlightcontroller/Installation+Guide, and instructions for obtaining the source code can be obtained at http://www.projectfloodlight.org/download/.  Once you have obtained a Floodlight 0.9 jar file, place it at:
     34{{{
     35sudo mv <floodlight_jar> /home/openflow/floodlight/src/floodlight.jar
     36sudo chown openflow /home/openflow/floodlight/src/floodlight.jar
     37}}}
     38
     39== 6. (optional) Update properties file ==
     40If you need to change the <of_port> and/or the <rest_port> that the Floodlight instance binds to, then the modify following lines in `/home/openflow/floodlight/config/layer1transport.properties`:
     41{{{
     42net.floodlightcontroller.restserver.RestApiServer.port = <rest_port>
     43net.floodlightcontroller.core.FloodlightProvider.openflowport = <of_port>
     44}}}
     45
     46== 7. (optional) Update logback config ==
     47There are three reference logback configurations distributed with this software:
     48 * `/home/openflow/floodlight/conf/logback_file.xml`: logs floodlight messages to `/var/log/floodlight.log`
     49 * `/home/openflow/floodlight/conf/logback_stdout.xml`: logs floodlight messages to stdout
     50 * `/home/openflow/floodlight/conf/logback_syslog.xml`: logs floodlight messages to syslog system
     51
     52The layer1transport service uses the file `/home/openflow/floodlight/conf/logback.xml`, which by default is a symlink that points to `logback_file.xml`.  If you want to change which configuration you use, or if you want to use an alternate configuration, make modifications now.
     53
     54== 8. Create flows files ==
     55You will need to create files that define that flows that should be managed by the SFP module in floodlight.  The flows files '''must''' have a `.json` file extension in order to work with this service.  The API and the data format are defined in [http://docs.projectfloodlight.org/display/floodlightcontroller/Static+Flow+Pusher+API+%28New%29 the SFP documentation].  Defining the proper flows requires an understanding of your switch platforms, and where administrative flows are needed within the network.  Please coordinate with us if you would like help defining these, or if you would like us to sanity check.  One you have defined the flows in a set of files, place the files under `/home/openflow/floodlight/flows.d/`.  Two files are provided as a reference.
     56
     57Once you have created your flows files, please remove the reference files:
     58{{{
     59sudo -u openflow rm /home/openflow/floodlight/flows.d/gpo_to_i2_example.json
     60sudo -u openflow rm /home/openflow/floodlight/flows.d/gpo_to_nlr_example.json
     61}}}
     62
     63== 9. Install init.d script ==
     64Move the init.d script into place and set the appropriate permissions:
     65{{{
     66sudo mv /home/openflow/floodlight/etc/init.d/layer1transport /etc/init.d/layer1transport
     67sudo chown root:root /etc/init.d/layer1transport
     68}}}
     69
     70If you changed the <rest_port> from the default value, update the following line in `/etc/init.d/layer1transport`:
     71{{{
     72REST_PORT=<rest_port>
     73}}}
     74
     75== 10. Start the service ==
     76Start the script if it isn't running already:
     77{{{
     78sudo service layer1transport start
     79}}}
     80
     81You can check the status of the script with:
     82{{{
     83sudo service layer1transport status
     84}}}
     85
     86== 11. Set the service to start on boot ==
     87Configure the host, either through an OS-specific tool or through a configuration management system, to have the layer1transport service to start up at boot time.
     88
     89== 12. Poke holes in firewalls as needed ==
     90If you need to poke a hole in the firewall (either in the network or on the controller host itself) for the switch to reach <of_port> on the controller, do this now.
     91
     92== 13. Point switch instances at new controller ==
     93For each OF instance that needs to have flows installed, point the instance at administrative Floodlight instance that you stood up.  How this gets done will depend on the switch platform.  You will point the switch at the <of_port>.