The OpenOLT agent runs on white box Optical Line Terminals (OLTs) and provides a gRPC-based management and control interface to OLTs.
The OpenOLT agent is used by VOLTHA through the OpenOLT adapter.
OpenOLT agent uses Broadcom's BAL (Broadband Adaptation Layer) software for interfacing with the Maple/Qumran chipsets in OLTs such as the Edgecore/Accton ASXvOLT16 and with Aspen/Qumran chipsets in OLTs such as the Radisys RLT-3200G-W. The current version of the Broadcom BAL integrated with OpenOLT agent is BAL3.10.2.2.
+---------------------------------+ | VOLTHA | | | | +------------------+ | | | OpenOLT adapter | | +-------+--------+---------+------+ | OpenOLT gRPC API | | +--------------------- ---------------+ | | | | +------------------+ | | | OpenOLT agent | | | +--------+---------+ | | | | | Vendor specific | (e.g. Broadcom | | API | BAL API | | | | | +------------------+ | | | Vendor SoC/FPGA | | | |(e.g Maple/Qumran)| | | +------------------+ | | | | White box OLT | +-------------------------------------+
A list of tested devices and optics can be found in the CORD hardware requirements guide, in the R-CORD access equipment and optics section.
Accton/Edgecore makes available pre-built debian packages of OpenOLT agent to their customers. Get access credentials for edgecore.quickconnect.to and then login and navigate to File_Station -> EdgecoreNAS, and then the folder /ASXvOLT16/OpenOLT_Agent/From_ONF_Distribution/ and pick the right version of .deb package required for your testing.
Copy the debian package to the OLT. For example:
scp openolt.deb root@10.6.0.201:~/.
Install the openolt.deb package using dpkg:
dpkg -i openolt_<OPENOLTDEVICE>-<Version>-<GIT Commit ID>.deb
Rebooting the OLT (after the installation) will start dev_mgmt_daemon and openolt as system services:
reboot
The services can also be stopped/started manually:
service dev_mgmt_daemon stop
service openolt stop
service dev_mgmt_daemon start
service openolt start
Check the status of the services:
service dev_mgmt_daemon status
service openolt status
Running the dev_mgmt_daemon and/or openolt services in the foreground is useful for development and debugging. Make sure to first stop the services if they are running in background.
service dev_mgmt_daemon stop
service openolt stop
Open a terminal and run the Broadcom BAL software (dev_mgmt_daemon):
cd /broadcom ./dev_mgmt_daemon -d -pcie
Perform dev_mgmt_daemon and change NNI port speed:
cd /broadcom ./dev_mgmt_daemon -d -pcie -port_100g_speed 40000
cd /broadcom ./dev_mgmt_daemon -d -pcie -port_100g_speed 10000 topology_config_file ./topology_config_16_ports.ini
cd /broadcom ./dev_mgmt_daemon -d -pcie -port_25g_speed 20000
cd /broadcom ./dev_mgmt_daemon -d -pcie -port_25g_speed 10000
cd /broadcom ./dev_mgmt_daemon -d -pcie -port_25g_speed 1000
cd /opt/bcm68650/ ./svk_init.sh -clean ./svk_init.sh -qsfp_speed=10g -sfp_speed=10g cd /broadcom ./dev_mgmt_daemon -d -pcie
cd /opt/bcm68650/ ./svk_init.sh -clean ./svk_init.sh -qsfp_speed=10g -sfp_speed=10g cd /broadcom ./dev_mgmt_daemon -d -pcie
cd /opt/bcm68650/ ./svk_init.sh -clean ./svk_init.sh -qsfp_speed=40g -sfp_speed=10g cd /broadcom ./dev_mgmt_daemon -d -pcie
The dev_mgmt_daemon executable presents the CLI for Broadcom's BAL when run in the foreground which is useful for debugging.
While the first executable still runs (even in background), open another terminal and run openolt:
cd /broadcom ./openolt --interface <interface-name> (or) ./openolt --intf <interface-name>
NOTE:
At the VOLTHA CLI, preprovision and enable the OLT:
(voltha) preprovision_olt -t openolt -H YOUR_OLT_MGMT_IP:9191 (voltha) enable
To collect logs from openolt, dev_mgmt_daemon and syslog processes install td-agent(fluentd variant) directly on OLT device which will capture and transmits the logs to elasticsearch pod running in voltha cluster.
Prerequisite:
OLT should have ntp installed to ensure it has correct time(which is used by td-agent for generated events)
apt-get install ntp
Installation of td-agent deb package:
wget http://packages.treasuredata.com.s3.amazonaws.com/3/ubuntu/xenial/pool/contrib/t/td-agent/td-agent_3.8.0-0_amd64.deb
dpkg -i td-agent_3.8.0-0_amd64.deb
Post Installation:
We have created custom td-agent configuration file to handle format of involved log files using right input plugins and elasticsearch output plugin.
Copy the custom config file from here in the ~ directory of the olt. Then into the /etc folder in order for the agent to pick it up.
cp td-agent.conf /etc/td-agent.conf
service td-agent restart
Need to redirect syslog to default port of fluentd syslog plugin.
/etc/init.d/rsyslog restart
Note:
To enable TLS encryption features with td-agent look at this google doc
The PonTrxBase class defined in agent/device/device.(h/cc) provides base implementation with the following capabilities
onlpdump utility on the OLTThe base class implentation has to derived class PonTrx defined in vendor specific modules and if needed override the base class methods to provide vendor specific implementation. See agent/device/sim/vendor.(h/cc) for how this is done for the simulated vendor used in unit tests.
The usual steps involved in openolt-agent startup is below
read_sfp_presence_data)read_eeprom_data_for_sfp)decode_eeprom_data)get_mac_system_mode and get_sfp_mode to get the modes while configuring the MAC and the PON respectively.If any vendor does not want to support dynamic MAC and PON mode configuration, then do not define DYNAMIC_PON_TRX_SUPPORT in agent/device/<vendor-folder>/vendor.h and then provide the definition of DEFAULT_MAC_SYSTEM_MODE and DEFAULT_PON_MODE that you would want to use for your device.
All that is described in the earlier section is supported today for supporting Dynamic PON Trx detection and configuration of MAC and PON mode.
PonTrxBase implementation. But this, as the name suggests, is a base class implementation - could always be overriden in the derived class if you need a sophesticated implementation.Refer BUILDING guide for details on how to build openolt agent.
The information here may be specific to specific OLT and ONU hardware such as Edgecore ASFVOLT16 OLT, Radisys RLT-3200G-W OLT and Broadcom based ONUs.
Auto-negotiation on the NNI (Network to Network Interface) uplink ports is not tested.
By default, the OpenOLT agent sets the speed of the NNI interfaces to 100G. To downgrade the network interface speed to 40G, add the following lines at the end of the /broadcom/qax.soc configuration file.
port ce128 sp=40000
A restart of the dev_mgmt_daemon and openolt services is required after making this change.
To get access to the BCM.0> maple console, SSH into the OLT and then execute:
cd /broadcom ./example_user_appl
Following is an example of retrieving the interface description for PON intf_id 0
(TODO: document PON interface numbering for Edgecore OLT).
BCM.0> a/t clear=no object=pon_interface sub=itu_pon_stats pon_ni=0 [-- API Start: bcmolt_stat_get --] [-- API Message Data --] object: pon_interface- PON Network Interface. get stat subgroup: itu_pon_stats-ITU PON Statistics. loid: 0 response: OK key={pon_ni=0} data={ fec_codewords=0 bip_units=0 bip_errors=0 rx_gem=0 rx_gem_dropped=0 rx_gem_idle=0 rx_gem_corrected=0 rx_crc_error=0 rx_fragment_error=0 rx_packets_dropped=0 rx_dropped_too_short=0 rx_dropped_too_long=0 rx_key_error=0 rx_cpu_omci_packets_dropped=0 tx_ploams=157 rx_ploams_dropped=0 rx_allocations_valid=0 rx_allocations_invalid=0 rx_allocations_disabled=0 rx_ploams=39 rx_ploams_non_idle=39 rx_ploams_error=0 rx_cpu=0 rx_omci=0 rx_omci_packets_crc_error=0 tx_packets=0 tx_gem=0 tx_cpu=0 tx_omci=0 tx_dropped_illegal_length=0 tx_dropped_tpid_miss=0 tx_dropped_vid_miss=0 tx_dropped_total=0 rx_xgtc_headers=39 rx_xgtc_corrected=0 rx_xgtc_uncorrected=0 fec_codewords_uncorrected=0 rx_fragments_errors=0 } [-- API Complete: 0 (OK) --]
Following command retrieves NNI intf_id 0:
BCM.0> a/t clear=no object=nni_interface sub=stats id=0 [-- API Start: bcmolt_stat_get --] [-- API Message Data --] object: nni_interface- nni_interface. get stat subgroup: stats-NNI Interface Statistics. loid: 0 response: OK key={id=0} data={ rx_bytes=40023 rx_packets=283 rx_ucast_packets=0 rx_mcast_packets=283 rx_bcast_packets=0 rx_error_packets=0 rx_unknown_protos=0 tx_bytes=0 tx_packets=0 tx_ucast_packets=0 tx_mcast_packets=0 tx_bcast_packets=0 tx_error_packets=0 } [-- API Complete: 0 (OK) --]
Following command lists the flows installed on the OLT.
BCM.0> a/m max_msgs=100 filter_invert=no object=flow
dev_mgmt_daemon and openolt agent binary as services?Navigate to /opt/bcm68620 and execute the command /broadcom/dev_mgmt_attach to access the QAX diagnostic shell. If you are not able to access the shell, you need to recompile the BAL SDK with SW_UTIL_SHELL=y option set.
Ensure that additional_bw indicator in the Technology Profile and the bandwidthprofile configured in ONOS netcfg for the subscriber are following the below guideline.
additional_bw is configured as AdditionalBW_BestEffort, ensure cir + eir values in ONOS netcfg BW profile for the subscriber are greater than or equal to 16000 for XGSPON, and it is greater than equal to 32000 for GPON. Also ensure that eir is a non-zero value.additional_bw is configured as AdditionalBW_NA, ensure that both cir and eir are non-zero values, and cir + eir is greater than or equal to 16000 for XGSPON and 32000 for GPON.additional_bw is configured as AdditionalBW_None, ensure that eir is 0 and cir is non-zero and cir is greater than or equal to 16000 for XGSPON, and it is greater than equal to 32000 for GPON.For more details about BW profile parameters, please refer below links.
MEF Wiki - Bandwidth-Profiles-for-Ethernet-Services Technology Profile Implementation Note