Changes between Version 22 and Version 23 of Old/WiMAX/17

Timestamp:

Nov 8, 2013, 5:14:06 PM (10 years ago)

Author:

davide

Comment:

Update installation and configuration for new wimaxrf.

Old/WiMAX/17

@@ -5 +5 @@
 [[TOC(WiMAX/17*, depth=2, heading=WiMAX RF Aggregate Manager)]]
 
-== Installation ==
+== Installation for NEC BS ==
 
 {{{
@@ -31 +31 @@
 }}}
 
+== Installation for Airspan BS ==
+
+{{{
+apt-get install click wimaxrf
+}}}
+
+This will install the WimaxRF AM service along with the required OMF packages and the Click software router. An ASN gateway is not needed to operate the Airspan base station.
+Please confirm that the most current packages of the software are installed. You can check them with the following command.
+
+{{{
+dpkg -l | egrep 'omf-|click|wimaxrf'
+}}}
+The output should be similar to this:
+{{{
+ii  omf-aggmgr-5.2                      ubuntu6                                  OMF Aggregate Manager
+ii  omf-common-5.2                      ubuntu4                                  Common ruby classes for OMF
+}}}
+
+
 == Configuration ==
 
-The configuration file for wimxrf AM is in the same location as for all the other OMF AM services in /etc/omf-agggr-5.2/available/wimaxrf.yaml. The configuration file consists of multiple section sections relating to different components of the services. 
+The configuration file for wimaxrf AM is in the same location as for all the other OMF AM services in `/etc/omf-aggmgr-5.4/available/wimaxrf.yaml`. The configuration file consists of multiple sections relating to different components of the services.
 
 Default parameter values are shown in []; Bold font indicates mandatory parameters.
@@ -41 +60 @@
 }}}
 
-=== Database section ===
+=== database section ===
 {{{
   database:
-   dbFile: '/db/wimaxrf.db'
+   dbFile: 'db/wimaxrf.db'
   reset:
    file: '/defaults/reset.xml'
 }}}
 
- * '''file''': location of the default configuration [none]. The file is an XML file that containes default BS parameters and is used with '''/default''' wimaxrf service
-
-=== asngw: Section ===
-
+ * '''dbFile''': SQLite 3.x database file that contains datapaths configuration and authorized clients.
+ * file: location of the default configuration [none]. The file is an XML file that contains default BS parameters and is used with '''/default''' wimaxrf service.
+
+=== asngw section ===
+
+This section is unused on Airspan and thus ignored.
 {{{
   asngw:
@@ -64 +85 @@
 }}}
 
-=== bs: section ===
-{{{  
+=== bs section ===
+{{{
   bs: 
-   ip: 10.3.0.1
-   mask: 255.255.0.0
-   bsid: 44:51:DB:00:00:01 
-   frequency: 2590000
-   stats:
-     localoml:
-       :omlServer: oml.orbit-lab.org
-       interval: 10
-     globaloml:
-       :omlServer: oml.orbit-lab.org
-}}}
-'''localoml''' section is used to specify OML server that will receive client related measurements while '''globaloml''' server section is used to configure parameters that are used by global GENI-wide logging process (should point at '''oml.orbit-lab.org''' until GENI gmoc takes over reporting function). Both are configured with two parameters:
-  * ''':omlServer:''': value is the hostname of your OML server. If you wish to install the oml2 server on your host[[BR]] locally, please do so by the following commands.
-{{{
-  apt-get install oml2-server 
+    type: airspan/nec
+    bsid: 44:51:db:00:xx:yy
+    ip: 10.3.x.y
+    mask: 255.255.0.0
+    mgmt_if: eth0.1
+    data_if: eth0
+    frequency: 2590000
+    stats:
+      localoml:
+        :omlServer: oml.orbit-lab.org
+        interval: 20
+      globaloml:
+        :omlServer: oml.orbit-lab.org
+}}}
+
+ * '''type''': BS type, `airspan` and `nec` are currently supported
+ * '''bsid''': globally-assigned ID of the base station
+ * '''ip''': the base station IP address
+ * '''mgmt_if''': the name of the network interface on the local machine that is used to communicate with the base station for management purposes (e.g. SNMP calls, traps, etc...)
+ * '''data_if''': the name of the network interface over which data traffic to and from the BS will flow. Can be the same as `mgmt_if`
+ * The '''localoml''' section is used to specify the OML server that will receive client-related measurements while '''globaloml''' server section is used to configure parameters that are used by global GENI-wide logging process (should point at `oml.orbit-lab.org` until GENI gmoc takes over reporting function). Both are configured with two parameters:
+  * ''':omlServer:''': value is the hostname of your OML server. If you wish to install the oml2 server on your host locally, please do so by the following commands.
+{{{
+apt-get install oml2-server 
 }}}
  and then point the omlServer value to your localhost.
-  * '''interval:''': collection itnerval in seconds (defaults: [10] for localoml and [300] for globaloml) 
+  * interval: collection interval in seconds (defaults: [10] for localoml and [300] for globaloml) 
 
 === datapath: section ===
-
-Default interface for datapath outside endpoint:
 
 {{{       
   datapath:
-    datapathif: eth0
-}}}
-
-Each of the sections in this file should be modified to reflect your deployment configuration (please keep in mind that this is a YAML file and that it depends heavily on spaces and not TABs). Once the configuration file is ready, you have to enable the service by creating the symbolic link in /etc/omf-aggmgr-5.2/enabled:
-
-{{{
+    manage_interface: true
+}}}
+
+ * manage_interface [false]: whether wimaxrf is allowed to create and destroy VLANs on the datapath interface when adding or deleting datapaths via `/datapath/add` and `/datapath/delete`. If set to false, the system administrator must ensure that any required VLANs have been properly setup prior to adding the datapath to wimaxrf.
+
+Each of the sections in this file should be modified to reflect your deployment configuration (please keep in mind that this is a YAML file and that it depends heavily on spaces and not TABs). Once the configuration file is ready, you have to enable the service by creating a symbolic link in /etc/omf-aggmgr-5.4/enabled:
+
+{{{
+cd /etc/omf-aggmgr-5.4/enabled
 ln -s ../available/wimaxrf.yaml
 }}}
@@ -103 +134 @@
 and restarting the OMF aggregate manager service:
 {{{
-/etc/init.d/omf-aggmgr-5.2 restart
-}}}
-
-=== Example configuration ===
+/etc/init.d/omf-aggmgr-5.4 restart
+}}}
+
+=== Example NEC configuration ===
 
 {{{
@@ -117 +148 @@
 wimaxrf:
   database:
-   #sqlite db file
    dbFile: '/db/wimaxrf.db'
   reset:
@@ -131 +161 @@
    dsc: IP-Config-Mgmt
   
-  bs: 
+  bs:
+   type: nec
    ip: 10.3.0.61
    mask: 255.255.0.0
@@ -147 +178 @@
 }}}
 
+=== Example Airspan configuration ===
+
+{{{
+# NOTE: use only 'spaces' to indent !
+# ('tab' indents are not supported by the ruby yaml parser used to read this file)
+#
+# This is the Config file for the WiMAXRF GridService
+#
+---
+wimaxrf:
+
+  database:
+    dbFile: 'db/wimaxrf.db'
+
+  bs:
+    type: airspan
+    bsid: 44:51:db:00:00:10
+    ip: 10.3.0.10
+    mask: 255.255.0.0
+    mgmt_if: eth1
+    data_if: eth1.500
+    frequency: 2572000
+    stats:
+      localoml:
+       :omlServer: oml.orbit-lab.org
+      globaloml:
+        :omlServer: oml.orbit-lab.org
+
+  datapath:
+    manage_interface: true
+}}}