protocol_plugins.packetcable/README.md

   1 ### Checkout the Controller and Plugin
   2
   3
   4     sudo apt-get install maven
   5     git clone https://git.opendaylight.org/gerrit/p/controller.git
   6
   7 ### XXX - CHANGE THIS
   8
   9     git clone  https://github.com/xsited/packetcable.git
  10
  11 ### Directory Organization
  12
  13 - in the parent is pom.xml for the entire packetcable projects.
  14 - this will build a working controller distribution
  15   based on the controller + packetcable modules
  16   packetcable/target/protocol_plugins.packetcable-0.5.0-SNAPSHOT.jar
  17 - md-sal experimental
  18 - docs for PoC documentation and notes and PCMM specification version I05
  19
  20
  21 ### Replacing OpenJDK on Ubuntu
  22
  23     apt-get purge -y openjdk*
  24     add-apt-repository ppa:webupd8team/java
  25     apt-get update
  26     apt-get install -y oracle-java7-installer
  27     apt-get --no-install-recommends install -y maven
  28
  29
  30 ### How to Build
  31
  32
  33 JDK 1.7+ and Maven 3+ are required:
  34
  35
  36 From the toplevel issue the following instructions to build the controller:
  37
  38     cd controller/opendaylight/distribution/opendaylight
  39
  40     export JAVA_HOME=/usr
  41     mvn clean install
  42
  43
  44 or if you want to avoid SNAPSHOT checking use:
  45
  46     mvn clean install -nsu
  47     // mvn clean install -DskipTests
  48
  49
  50 From the toplevel issue the following instructions to build the packetcable SB plugin:
  51
  52     cd packetcable
  53     mvn clean install
  54
  55 From the toplevel issue the following instructions to build the packetcable model:
  56
  57     cd packetcable/md-sal
  58     mvn clean install
  59
  60
  61 ### How to Run
  62
  63
  64 Upon successful completion of a build install and run from the toplevel:
  65
  66     ./copy.sh
  67     export JAVA_HOME=/usr
  68     ./run.sh
  69
  70 Wait for the osgi console to startup and then point a browser at
  71
  72     http://localhost:8080/
  73
  74
  75 From the osgi console, verify the plugin is active
  76
  77     osgi> ss | grep packetcable
  78     110 ACTIVE      org.opendaylight.controller.protocol_plugins.packetcable_0.4.0.SNAPSHOT true
  79
  80     osgi> dm 110
  81     [110] org.opendaylight.controller.protocol_plugins.packetcable
  82       org.opendaylight.controller.sal.flowprogrammer.IPluginInFlowProgrammerService(protocolPluginType=PC) registered
  83       org.opendaylight.controller.sal.utils.INodeFactory(protocolName=PC,protocolPluginType=PC) registered
  84       org.opendaylight.controller.sal.utils.INodeConnectorFactory(protocolName=PC,protocolPluginType=PC) registered
  85       org.opendaylight.controller.sal.inventory.IPluginInInventoryService(scope=Global,protocolPluginType=PC) registered
  86       org.opendaylight.controller.sal.inventory.IPluginOutInventoryService (scope=Global) service required available
  87       org.opendaylight.controller.sal.reader.IPluginInReadService(protocolPluginType=PC,containerName=default) registered
  88       org.opendaylight.controller.sal.inventory.IPluginInInventoryService(protocolPluginType=PC,containerName=default) registered
  89
  90
  91     osgi> s | grep packetcable
  92     110 file:/home/mininet/controller/opendaylight/distribution/opendaylight/target/distribution.opendaylight-0.1.1-SNAPSHOT-osgipackage/opendaylight/plugins/protocol_plugins.packetcable-0.4.0-SNAPSHOT.jar
  93       ACTIVE      org.opendaylight.controller.protocol_plugins.packetcable_0.4.0.SNAPSHOT [110] true
  94
  95     osgi>
  96
  97
  98 ### Acknowledgements and Contributions
  99
 100
 101 The project development lead from
 102 Thomas Kee (xsited@yahoo.com)
 103
 104 The fantastic Java stylings and support from
 105 Riadh HAJ AMOR (rhadjamor@gmail.com)
 106
 107 The COPS for Java foundation from
 108 Copyright (c) 2004 University of Murcia.  All rights reserved.
 109 For more information, please see <http://www.umu.euro6ix.org/>.
 110 Félix Jesús García Clemente  (fgarcia@dif.um.es)
 111